Repository navigation
docs: fix three GitHub Actions examples that fail when copied - #832
Open
simonvanlierde wants to merge 1 commit into
Open
simonvanlierde wants to merge 1 commit into
simonvanlierde wants to merge 1 commit into
Conversation
- trusted-publishing: align step keys so the Step 3 YAML parses, and move its checkout and setup-python to v7, as the example workflow uses - run-tests: pin actions/checkout to a commit that exists (v7.0.1) - tests-ci: run the nox session the nox page defines (test, not tests), and update checkout, setup-python and codecov-action
✅ Deploy Preview for python-package-guide ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This branch has not been deployed
This file contains hidden or 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
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.
Hi!
Three workflow examples fail when copied: one isn't valid YAML, one pins a checkout commit that doesn't exist, and one runs a nox session the nox page never defines.
tutorials/trusted-publishing.md: in Step 3,uses:,with:andrun:sat two spaces deeper thanname:, so the YAML doesn't parse. I lined them up, and moved checkout and setup-python to v7 to match the example workflow further down the page.tests/run-tests.md: the checkout SHA is 39 characters, and GitHub has no such commit. It now pins v7.0.1, the same SHA asexamples/pure-hatch.tests/tests-ci.md:nox -s tests-<version>is nowtest-<version>, the sessionrun-tests-nox.mddefines. I also bumped checkout, setup-python and codecov-action to v7; codecov's README says v7 needstoken: ${{ secrets.CODECOV_TOKEN }}.Tests:
nox -s docs-testpasses, and so do the translated builds. Every YAML block on the trusted-publishing page parses. I left Python 3.9 in both matrices (end of life since October 2025), since dropping it is your call.Best,
Simon