Use pyproject.toml as Python version source
#292
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All execution, development and validation for the project is performed using a specific version of Python. Poetry is used for Python package dependencies management. Poetry installs dependencies into a virtual environment. For this reason, the Poetry configuration includes a Python version number, which must match the correct version of Python for the project. This configuration is stored in the `pyproject.toml` file. Python is installed in the GitHub Actions runner environments using the actions/setup-python action, which also must be configured to install the correct version of Python. Previously a the version number for use by the actions/setup-python action was defined in the `.python-version` file. This allowed the Python version for use by the arduino/compile-sketches action's execution and all the workflows that make up its infrastructure to be configured from a single source. However, Poetry does not support the `.python-version` file so we were stuck with two copies of the Python version information, which must be kept in sync. Fortunately, support for using `pyproject.toml` as the version file for the actions/setup-python action was recently added. This means it is now possible for all components of the project infrastructure to get the Python version from a single source.
per1234
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All execution, development and validation for the project is performed using a specific version of Python.
Poetry is used for Python package dependencies management. Poetry installs dependencies into a virtual environment. For this reason, the Poetry configuration includes a Python version number, which must match the correct version of Python for the project. This configuration is stored in the
pyproject.tomlfile.Python is installed in the GitHub Actions runner environments using the actions/setup-python action, which also must be configured to install the correct version of Python. Previously the version number for use by the actions/setup-python action was defined in the
.python-versionfile. This allowed the Python version for use by the arduino/compile-sketches action's execution and all the workflows that make up its infrastructure to be configured from a single source. However, Poetry does not support the.python-versionfile so we were stuck with two copies of the Python version information, which must be kept in sync.Fortunately, support for using
pyproject.tomlas the version file for the actions/setup-python action was recently added (actions/setup-python@0d5da6a). This means it is now possible for all components of the project infrastructure to get the Python version from a single source.