Allow caller workflows to use pyproject.toml files as the source of t…

…he Python version (#216) * feat: Add the ability for calling workflows to specify to use the Python version stored in the pyproject.toml file instead of hard-coding the Python version in the workflows as well * docs: Updated the changelog * fix: Add known words to avoid doc build failures
tektronix · Nov 13, 2024 · 7ef29f1 · 7ef29f1
1 parent 91e0f54
commit 7ef29f1
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 17 deletions.
diff --git a/.github/workflows/_reusable-test-code.yml b/.github/workflows/_reusable-test-code.yml
@@ -9,7 +9,9 @@ on:
         required: true
         type: string
       python-versions-array:
-        description: A valid JSON array of Python versions to test against.
+        description: A valid JSON array of Python versions to test against. A valid
+          option is also the string 'pyproject.toml', indicating to use the defined
+          Python version from the pyproject.toml file.
         required: true
         type: string
       operating-systems-array:
@@ -46,11 +48,18 @@ jobs:
         with:
           node-version: lts/*
           check-latest: true
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python (version)
+        if: ${{ matrix.python-version != 'pyproject.toml' }}
         uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
           python-version: ${{ matrix.python-version }}
           check-latest: true
+      - name: Set up Python (pyproject.toml)
+        if: ${{ matrix.python-version == 'pyproject.toml' }}
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version-file: ${{ matrix.python-version }}
+          check-latest: true
       - name: Install dependencies
         run: python -m pip install tox tox-gh-actions
       - name: Set up pre-commit cache

diff --git a/.github/workflows/_reusable-test-docs.yml b/.github/workflows/_reusable-test-docs.yml
@@ -8,7 +8,8 @@ on:
         required: true
         type: number
       python-version:
-        description: The version of Python to install.
+        description: The version of Python to install. It can also be the string 'pyproject.toml',
+          indicating to use the defined Python version from the pyproject.toml file.
         required: true
         type: string
       tox-env-array:
@@ -35,11 +36,18 @@ jobs:
         run: |
           npm install --global @mermaid-js/mermaid-cli
           sudo apt install --no-install-recommends --assume-yes graphviz
-      - name: Set up Python
+      - name: Set up Python (version)
+        if: ${{ inputs.python-version != 'pyproject.toml' }}
         uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
           python-version: ${{ inputs.python-version }}
           check-latest: true
+      - name: Set up Python (pyproject.toml)
+        if: ${{ inputs.python-version == 'pyproject.toml' }}
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version-file: ${{ inputs.python-version }}
+          check-latest: true
       - name: Install tox
         run: python -m pip install tox
       - name: Test

diff --git a/.github/workflows/test-code.yml b/.github/workflows/test-code.yml
@@ -16,7 +16,7 @@ jobs:
     with:
       repo-name: tektronix/python-package-ci-cd
       operating-systems-array: '["ubuntu", "windows", "macos"]'  # this needs to match the operating-systems-array in the publish-test-results.yml file
-      python-versions-array: '["3.12"]'  # this needs to match the [tool.poetry.dependencies.python] version in the pyproject.toml file
+      python-versions-array: '["pyproject.toml"]'
       upload-to-codecov: true
     secrets:
       codecov-token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml
@@ -14,5 +14,5 @@ jobs:
     uses: ./.github/workflows/_reusable-test-docs.yml
     with:
       node-version: 20  # The node version needs to stay in sync with .readthedocs.yml
-      python-version: '3.12'  # this needs to match the [tool.poetry.dependencies.python] version in the pyproject.toml file and stay in sync with .readthedocs.yml
+      python-version: pyproject.toml
       tox-env-array: '["docs", "doctests"]'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,10 @@ Valid subsections within a version are:
 
 Things to be included in the next release go here.
 
+### Added
+
+- Added the ability for caller workflows for the `_reusable-test-docs.yml` and `_reusable-test-code.yml` workflows to specify to use the `pyproject.toml` file as the source of the Python version instead of always requiring a hard-coded Python version.
+
 ### Changed
 
 - Bumped dependency versions.

diff --git a/doc_config/known_words.txt b/doc_config/known_words.txt
@@ -30,6 +30,7 @@ pr
 pre
 pypa
 pypi
+pyproject
 repo
 sarif
 sbom
@@ -39,6 +40,7 @@ stefanzweifel
 sublicense
 tektronix
 testpypi
+toml
 update_development_dependencies
 vimtor
 white_check_mark

diff --git a/workflows/test-code.md b/workflows/test-code.md
@@ -106,12 +106,12 @@ commands_pre =
 
 ## Inputs
 
-| Input variable            | Necessity | Description                                                                                 | Default                            |
-| ------------------------- | --------- | ------------------------------------------------------------------------------------------- | ---------------------------------- |
-| `repo-name`               | required  | The full name of the repository to use to gate Codecov uploads, in the format `owner/repo`. |                                    |
-| `python-versions-array`   | required  | A valid JSON array of Python versions to test against.                                      |                                    |
-| `operating-systems-array` | optional  | A valid JSON array of operating system names to run tests on.                               | `'["ubuntu", "windows", "macos"]'` |
-| `upload-to-codecov`       | optional  | A boolean indicating if coverage results should be uploaded to Codecov.                     | `false`                            |
+| Input variable            | Necessity | Description                                                                                                                                                                           | Default                            |
+| ------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `repo-name`               | required  | The full name of the repository to use to gate Codecov uploads, in the format `owner/repo`.                                                                                           |                                    |
+| `python-versions-array`   | required  | A valid JSON array of Python versions to test against. A valid option is also the string 'pyproject.toml', indicating to use the defined Python version from the pyproject.toml file. |                                    |
+| `operating-systems-array` | optional  | A valid JSON array of operating system names to run tests on.                                                                                                                         | `'["ubuntu", "windows", "macos"]'` |
+| `upload-to-codecov`       | optional  | A boolean indicating if coverage results should be uploaded to Codecov.                                                                                                               | `false`                            |
 
 ## Secrets
 

diff --git a/workflows/test-docs.md b/workflows/test-docs.md
@@ -68,11 +68,11 @@ commands =
 
 ## Inputs
 
-| Input variable   | Necessity | Description                                    | Default                  |
-| ---------------- | --------- | ---------------------------------------------- | ------------------------ |
-| `node-version`   | required  | The version of Node.js to install.             |                          |
-| `python-version` | required  | The version of Python to install.              |                          |
-| `tox-env-array`  | optional  | A valid JSON array of tox environments to run. | `'["docs", "doctests"]'` |
+| Input variable   | Necessity | Description                                                                                                                                              | Default                  |
+| ---------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
+| `node-version`   | required  | The version of Node.js to install.                                                                                                                       |                          |
+| `python-version` | required  | The version of Python to install. It can also be the string 'pyproject.toml', indicating to use the defined Python version from the pyproject.toml file. |                          |
+| `tox-env-array`  | optional  | A valid JSON array of tox environments to run.                                                                                                           | `'["docs", "doctests"]'` |
 
 ## Example