Switch GitHub workflows used in CI from tox environments to nox sessions #2685
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
github-actions
bot
added
CI
namurphy
changed the title
In the past, I've occasionally updated the OS or version of Python in one place, but not the other. By generating names from the matrix, it'll make it more likely that there will be self-consistency. (Also: DRY principle)
I wasn't able to get it to work.
namurphy
added
test failure is unrelated
namurphy
removed
docs
The purpose of this commit is primarily to test if the labeler GitHub Action is working.
github-actions
bot
added
docs
ejohnson-96
approved these changes
May 16, 2024
The three checks that are waiting are because I changed the names of the tests in the GitHub Action, but I haven't yet gone into the repo settings to change the name of which tests are required since that would break all other PRs. I'll do that right after merging. Thank you as always for the reviews! |
github-actions
bot
removed
the
status: ready for review
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.
Most of our GitHub workflows and heretofore been based on tox environments. However, the configuration files for tox is in an INI format, which I've perpetually had trouble understanding and maintaining. In contrast, nox is a test runner that is directly inspired by tox, with the exception that nox configuration files are written in Python.
I've spent perhaps a tenth as much time working with nox than I have with tox, and I already have a much better understanding of working with nox. For a Python project, it makes a lot of sense to configure things in Python when possible. Switching to nox will move us half of the way from removing INI files from our configuration. (The remaining files is
mypy.ini, though the configuration for that will eventually go inpyproject.toml.)In the recent past, we've had a few PRs that switched tox environments to nox sessions (#2654, #2664, #2656, #2681, #2683). This PR switches several of our GitHub workflows over from using tox environments to using nox sessions.
Closes #1734 at long last!
Important
Some of the checks are showing as "Expected" without being performed because I changed the names of some checks in this pull request without changing the names of required checks in the repository settings. So, it's expected that the "Expected" checks should be unexpected. 😅