Finish transition from tox to Nox for current continuous integration checks and weekly tests #2694
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
testing
CI
github-actions
bot
added
the
maintenance
github-actions
bot
added
the
GitHub Actions
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2694 +/- ##
=======================================
Coverage 95.23% 95.23%
=======================================
Files 104 104
Lines 9399 9399
Branches 2155 2155
=======================================
Hits 8951 8951
Misses 272 272
Partials 176 176 ☔ View full report in Codecov by Sentry. |
To make sure that mypy is run consistently across platforms.
I updated the conditions when this workflow happens so that it is only done as a cron job for PlasmaPy/PlasmaPy@main, but will still run on PRs with the appropriate label, and by workflow dispatch.
github-actions
bot
added
linters
This makes it so that mypy checks are not being performed with pinned requirements. If we run into problems where mypy checks suddenly start breaking due to breaking changes in mypy, then we can revisit this.
namurphy
changed the title
namurphy
commented
May 17, 2024
| @@ -12,12 +16,10 @@ on: | |||
| workflow_dispatch: | |||
|
|
|||
| env: | |||
| DOC_TROUBLESHOOTING: "Warnings like 'reference target not found' occur when Sphinx tries to interpret text as a Python object, but is unable to do so. This warning can often be fixed by surrounding text in double back ticks instead of single back ticks (e.g., by changing `y` to ``y``) so that it gets formatted as an in-line literal. For more information about addressing documentation build failures, please check out the documentation troubleshooting guide at: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#troubleshooting" | |||
There was a problem hiding this comment.
🛗 I moved this into the Nox session (with some edits).
namurphy
commented
May 17, 2024
| - name: Install nox and uv | ||
| - name: Install graphviz and pandoc for documentation builds | ||
| if: startsWith(matrix.name, 'Documentation') | ||
| run: sudo apt-get install graphviz pandoc |
There was a problem hiding this comment.
namurphy
commented
May 17, 2024
Comment on lines
-103
to
-145
|
|
||
| documentation: | ||
|
|
||
| name: Documentation, Python 3.12, Ubuntu | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
|
|
||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install graphviz and pandoc | ||
| run: sudo apt-get install graphviz pandoc | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.12' | ||
| cache: pip | ||
|
|
||
| - name: Install nox uv | ||
| run: python -m pip install --progress-bar off --upgrade nox uv | ||
|
|
||
| - name: Cache | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: | | ||
| .nox | ||
| key: docs-${{ runner.os }}-${{ hashFiles('requirements.txt') }} | ||
|
|
||
| - name: Build documentation with Sphinx | ||
| run: nox -e docs -- -q | ||
|
|
||
| - name: Print troubleshooting information on failure | ||
| if: ${{ failure() }} | ||
| run: echo -e $DOC_TROUBLESHOOTING |
There was a problem hiding this comment.
There was a lot of duplication in the workflows for building docs and running tests, so I merged them together above.
namurphy
commented
May 17, 2024
Comment on lines
+20
to
+23
| if: >- | ||
| github.event_name == 'workflow_dispatch' || | ||
| (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'perform linkcheck in CI')) || | ||
| (github.event_name == 'schedule' && github.repository == 'PlasmaPy/PlasmaPy' && github.ref == 'refs/heads/main') |
There was a problem hiding this comment.
📝 This is saying that this workflow should only be run:
- If we manually trigger it (via workflow dispatch)
- It's a pull request that has been labeled with "perform linkcheck in CI"
- As a cron job if it's on the
mainbranch ofPlasmaPy/PlasmaPy.
My motivation here is to avoid cron jobs being run on forks, which can waste a lot of computing resources.
I'll be honest...ChatGPT helped me write this one.
namurphy
changed the title
…inst-dev-versions-of-dependencies
…inst-dev-versions-of-dependencies
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.
This PR concludes the switchover from tox to Nox. I wanted to finish this ahead of the PlasmaPy Summer School so that participants won't need to learn how to work with tox (or more specifically,
tox.ini).The changes in this PR include:
tox.iniin its entirely, and there was much rejoicing. Using tox has overall been great, except for the INI-formatted configuration files! (We still havemypy.ini...but I'm hoping that's only temporary.)requirements.txt, as inspired by Requirements files need to be rethought #2647. It's not being used in CI anymore or by any Nox sessions, so we don't need it. Plus, IDEs are much more adept at getting requirements information frompyproject.tomlthan they used to be.Some notes:
sudo apt installstep for pandoc and graphviz is specific to Ubuntu.mypyto thetestsdependency set, primarily because then we won't have requirements information defined innoxfile.pythat we have to update.Remaining tasks
noxfile.py