build: shorten requirements file names

jku · jku · commit 70555f6e1b62 · 2023-02-06T14:52:07.000+02:00
Signed-off-by: Jussi Kukkonen &lt;jkukkonen@google.com&gt;
diff --git a/.github/workflows/_test.yml b/.github/workflows/_test.yml
@@ -42,11 +42,11 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
-          cache-dependency-path: 'requirements/requirements*.txt'
+          cache-dependency-path: 'requirements/*.txt'
 
       - name: Install dependencies
         run: |
-          python3 -m pip install --constraint requirements/requirements-build.txt tox coveralls
+          python3 -m pip install --constraint requirements/build.txt tox coveralls
 
       - name: Run tox (${{ env.TOXENV }})
         # See TOXENV environment variable for the testenv to be executed here
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -28,7 +28,7 @@ jobs:
           python-version: '3.x'
 
       - name: Install build dependency
-        run: python3 -m pip install --constraint requirements/requirements-build.txt build
+        run: python3 -m pip install --constraint requirements/build.txt build
 
       - name: Build binary wheel and source tarball
         run: python3 -m build --sdist --wheel --outdir dist/ .
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,6 +17,6 @@ formats: []
 # Optionally set the version of Python and requirements required to build your docs
 python:
   install:
-  - requirements: requirements/requirements-docs.txt
+  - requirements: requirements/docs.txt
   - method: pip
     path: .
diff --git a/docs/INSTALLATION.rst b/docs/INSTALLATION.rst
@@ -51,7 +51,7 @@ from GitHub, change into the project root directory, and install with pip
 
 ::
 
-   python3 -m pip install -r requirements/requirements-dev.txt
+   python3 -m pip install -r requirements/dev.txt
 
 
 Verify release signatures
diff --git a/requirements/build.txt b/requirements/build.txt
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -2,7 +2,7 @@
 # and also for running test suite or individual tests manually.
 # The build and tox versions specified here are also used as constraints
 # during CI and CD Github workflows
--r requirements-build.txt
--r requirements-test.txt
--r requirements-lint.txt
+-r build.txt
+-r test.txt
+-r lint.txt
 -e .
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1,7 +1,7 @@
 # Install documentation build requirements
 
 # pinned tuf runtime dependencies (should auto-update and -trigger ci/cd)
--r requirements-pinned.txt
+-r pinned.txt
 
 # install sphinx and its extensions
 sphinx
diff --git a/requirements/lint.txt b/requirements/lint.txt
@@ -1,7 +1,7 @@
 # Requirements needed in tox lint environment
 
 # pinned tuf runtime dependencies
--r requirements-pinned.txt
+-r pinned.txt
 
 # Lint tools
 # (We are not so interested in the specific versions of the tools: the versions
diff --git a/requirements/main.txt b/requirements/main.txt
@@ -3,7 +3,7 @@
 # This file together with 'pip-compile' is used to generate a pinned
 # requirements file with all immediate and transitive dependencies.
 #
-# 'requirements-pinned.txt' is updated on GitHub with Dependabot, which
+# 'pinned.txt' is updated on GitHub with Dependabot, which
 # triggers CI/CD builds to automatically test against updated dependencies.
 #
 #
@@ -17,7 +17,7 @@
 # Python < 3 only.
 #
 #
-# Below instructions can be used to re-generate 'requirements-pinned.txt', e.g.
+# Below instructions can be used to re-generate 'pinned.txt', e.g.
 # if:
 # - requirements are added or removed from this file
 # - Python version support is changed
@@ -29,15 +29,15 @@
 # for v in 3.7 3.8 3.9 3.10 3.11; do
 #   mkvirtualenv tuf-env-${v} -p python${v};
 #   python3 -m pip install pip-tools;
-#   pip-compile --no-header -o requirements-${v}.txt requirements.txt;
+#   pip-compile --no-header -o requirements-${v}.txt main.txt;
 #   deactivate;
 #   rmvirtualenv tuf-env-${v};
 # done;
 #
 # ```
 # 2. Use this command to merge per-version files
-#    `sort -o requirements-pinned.txt -u requirements-?.?.txt`
-# 2. Manually add environment markers to requirements-pinned.txt
+#    `sort -o pinned.txt -u requirements-?.?.txt`
+# 2. Manually add environment markers to pinned.txt
 # 3. Use this command to remove per-version files
 #    `rm requirements-?.?.txt`
 #
diff --git a/requirements/pinned.txt b/requirements/pinned.txt
diff --git a/requirements/test.txt b/requirements/test.txt
@@ -1,7 +1,7 @@
 # Requirements needed in tox test environments
 
 # pinned tuf runtime dependencies (should auto-update and -trigger ci/cd)
--r requirements-pinned.txt
+-r pinned.txt
 
 # coverage measurement
 coverage==7.1.0
diff --git a/tox.ini b/tox.ini
@@ -20,7 +20,7 @@ commands =
     python3 -m coverage report -m --fail-under 97
 
 deps =
-    -r{toxinidir}/requirements/requirements-test.txt
+    -r{toxinidir}/requirements/test.txt
     # Install TUF in editable mode, instead of tox default virtual environment
     # installation (see `skipsdist`), to get relative paths in coverage reports
     --editable {toxinidir}
@@ -43,7 +43,7 @@ commands =
 [testenv:lint]
 changedir = {toxinidir}
 deps =
-    -r{toxinidir}/requirements/requirements-lint.txt
+    -r{toxinidir}/requirements/lint.txt
     --editable {toxinidir}
 lint_dirs = tuf examples tests verify_release
 commands =
@@ -59,7 +59,7 @@ commands =
 
 [testenv:docs]
 deps =
-    -r{toxinidir}/requirements/requirements-docs.txt
+    -r{toxinidir}/requirements/docs.txt
 
 changedir = {toxinidir}
 commands =

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# This file together with 'pip-compile' is used to generate a pinned`
`4`	`4`	`# requirements file with all immediate and transitive dependencies.`
`5`	`5`	`#`
`6`		`-# 'requirements-pinned.txt' is updated on GitHub with Dependabot, which`
	`6`	`+# 'pinned.txt' is updated on GitHub with Dependabot, which`
`7`	`7`	`# triggers CI/CD builds to automatically test against updated dependencies.`
`8`	`8`	`#`
`9`	`9`	`#`
`@@ -17,7 +17,7 @@`
`17`	`17`	`# Python < 3 only.`
`18`	`18`	`#`
`19`	`19`	`#`
`20`		`-# Below instructions can be used to re-generate 'requirements-pinned.txt', e.g.`
	`20`	`+# Below instructions can be used to re-generate 'pinned.txt', e.g.`
`21`	`21`	`# if:`
`22`	`22`	`# - requirements are added or removed from this file`
`23`	`23`	`# - Python version support is changed`
`@@ -29,15 +29,15 @@`
`29`	`29`	`# for v in 3.7 3.8 3.9 3.10 3.11; do`
`30`	`30`	`# mkvirtualenv tuf-env-${v} -p python${v};`
`31`	`31`	`# python3 -m pip install pip-tools;`
`32`		`-# pip-compile --no-header -o requirements-${v}.txt requirements.txt;`
	`32`	`+# pip-compile --no-header -o requirements-${v}.txt main.txt;`
`33`	`33`	`# deactivate;`
`34`	`34`	`# rmvirtualenv tuf-env-${v};`
`35`	`35`	`# done;`
`36`	`36`	`#`
`37`	`37`	# ```
`38`	`38`	`# 2. Use this command to merge per-version files`
`39`		-# `sort -o requirements-pinned.txt -u requirements-?.?.txt`
`40`		`-# 2. Manually add environment markers to requirements-pinned.txt`
	`39`	+# `sort -o pinned.txt -u requirements-?.?.txt`
	`40`	`+# 2. Manually add environment markers to pinned.txt`
`41`	`41`	`# 3. Use this command to remove per-version files`
`42`	`42`	# `rm requirements-?.?.txt`
`43`	`43`	`#`