From 30f0a7c080c7c6efd2c6908602d7c4cb5b6d1386 Mon Sep 17 00:00:00 2001 From: Maxwell G Date: Thu, 26 Oct 2023 03:09:01 +0000 Subject: [PATCH] README: document Dependency files and PINNED envvar This documents the way dependency files are organized and handled by nox. Co-authored-by: Don Naro --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 433c166c3f..b88530961f 100644 --- a/README.md +++ b/README.md @@ -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