Convert reusable-nox workflowk to using nox GHA #3194
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,17 +11,17 @@ jobs: | |
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| # matrix: | ||
x1101 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # session: name of session | ||
| # python-versions: comma-separated list of Python versions to install | ||
| # extra-args (optional): extra arguments to pass to nox session. | ||
| - session: "static" | ||
x1101 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| python-versions: "3.12" | ||
| - session: "formatters_check" | ||
| python-versions: "3.12" | ||
| - session: "typing" | ||
| python-versions: "3.12" | ||
| - session: "spelling" | ||
| python-versions: "3.12" | ||
| - session: "checkers(rstcheck)" | ||
| python-versions: "3.12" | ||
|
|
@@ -34,19 +34,27 @@ jobs: | |
| - session: "pip-compile" | ||
| extra-args: "--check" | ||
| python-versions: "3.12" | ||
|
|
||
| name: "Run nox ${{ matrix.session }} session" | ||
| steps: | ||
| - name: Check out repo | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Setup nox | ||
| uses: wntrblm/[email protected] | ||
| with: | ||
| python-versions: "${{ matrix.python-versions }}" | ||
|
|
||
| - name: Graft ansible-core | ||
| uses: ansible-community/github-action-run-nox@v1 | ||
| with: | ||
| sessions: clone-core | ||
| force-pythons: "${{ matrix.python-versions }}" | ||
|
|
||
| - name: "Run nox session" | ||
| uses: ansible-community/github-action-run-nox@v1 | ||
| with: | ||
| sessions: "${{ matrix.session }}" | ||
| extra-args: "${{ matrix.extra-args || '' }}" | ||
| force-pythons: "${{ matrix.python-versions }}" | ||
|
Comment on lines
+54
to
+59
Member
There was a problem hiding this comment. Here's examples of splitting provisioning the venv and running the logic:
TL;DR for two steps to show up separately in CI, they should be actual separate entries in the step list (for the same session). The first one would run with
Contributor
Author
There was a problem hiding this comment. I'll have to dig into this. This might be the way to use the GHA as written and still achieve the two-step process you're looking for. What I'm not clear on (and I'll be looking into this) is if it will correctly re-use the sessions as expected. |
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What I meant originally is that this matrix should be in the calling workflow, not the reusable one. That would be
ci.yaml.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see what you mean. But I think that's a larger change to the workflow. As I understand it, the goal here is to take the existing workflow, which calls
noxdirectly from a matrix and replace it with one that uses the GHA.My preference would be to get the in-place change made and functional first before looking at reorganizing things.
That being said, if there's a strong desire to wrap that effort into this one, we can better outline that in the initial issue and I can look into tacking that too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem is that integrating this action the way it is now kinda makes it impossible to have this nice separation of steps. So I see it as contributing to poor inspectability of the log.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's probably a good idea to handle that first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree here. As written,
github-action-run-noxdoesn't work like that. That means we either decide not to use it, contribute upstream changes to enable that work (if the folks that maintain in accept them), or spin out a new GHA for this.