centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-27 13:28:51 +07:00
Code Issues Packages Projects Releases Wiki Activity

README: document Dependency files and PINNED envvar

Browse Source 
This documents the way dependency files are organized and handled by
nox.

Co-authored-by: Don Naro <dnaro@redhat.com>
This commit is contained in:
Maxwell G
2023-10-26 03:09:01 +00:00
parent 54b7657e0a
commit 30f0a7c080
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -85,9 +85,23 @@ Use [`codespell`](https://github.com/codespell-project/codespell) to check for c
nox -s spelling -- -w -i 3
```
## Dependency files
`nox` sessions use dependencies from requirements files in the `tests/` directory.
Each session has a `tests/{name}.in` file with direct dependencies and a lock file in `tests/{name}.txt` that pins *exact versions* for both direct and transitive dependencies.
The lock files contain tested dependencies that are automatically updated on a weekly basis.
If you'd like to use untested dependencies, set `PINNED=false` as in the following example:
```
PINNED=false nox -s "checkers(docs-build)"
```
For more details about using unpinned and tested dependencies for doc builds, see [Setting up your environment to build documentation locally](https://docs.ansible.com/ansible/latest/community/documentation_contributions.html#setting-up-your-environment-to-build-documentation-locally).
## Updating dependencies
Use the following `nox` session to update project dependency versions.
Use the following `nox` session to update the dependency lock files in `tests/`.
```
nox -e pip-compile