Repository navigation
fix(ci): clear the five actionlint findings without changing what the workflows do (#269) - #395
Merged
Merged
Conversation
… workflows do (#269) ci.yml, PII guard: the two patterns that end in a backslash are double-quoted so shellcheck stops reading them as a botched \' (SC1003 twice); the strings the loop passes to git grep -P are byte-identical. docs-rs.yml, docstring ratio: awk 'END { print NR }' replaces wc -l | tr (SC2126) and the source list is read into an array and expanded quoted (SC2046); the counts are unchanged. release.yml, publish-pypi: the literal if: false becomes a condition no trigger of the workflow can satisfy, with the reason in the comment, so the gate stays off.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
…ver true (#269) RELEASE.md and the CHANGELOG entry for this change no longer imply a literal if: false, and release.yml carries a one-line comment above the condition so it is not simplified back into the constant actionlint rejects.
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.
Summary
Clears the five actionlint findings on
main(ci.ymltwice,docs-rs.ymltwice,release.ymlonce) with quoting and expression changes only; no job name, trigger, step or threshold changes.Spec reference
None; CI only. Closes #269.
Test plan
actionlint 1.7.12 (Homebrew, with shellcheck) on
.github/workflows/*.yml, run in a worktree oforigin/main(d8690f4) and again on this branch.Before:
After (no output):
What each change does, and why behaviour is the same:
ci.yml, PII guard (SC1003 x2).'C:\\Users\\[a-z][a-z0-9._-]+\\'and'OneDrive - Autodesk\\[^\\]*\\'end in a backslash before the closing single quote, which shellcheck reads as a botched\'. They are now double-quoted with each\\written\\\\. Checked by sourcing thePATTERNSarray fromorigin/mainand from this branch in bash and comparing element by element: 5 of 5 strings are byte-identical, so thegit grep -P "$p"calls and the error message are unchanged.ci.yml, the issue's second acceptance item: each pattern matches one positive and one negative example.git grep --no-index -I -c -P "$p"over a positive file and a negative file, with the patterns taken from this branch:The positive lines were
/Users/jdoe/proj/file,/home/jdoe/proj/file,C:\Users\jdoe\proj,F:\Ship\2019_xandOneDrive - Autodesk\Jane\file; the negative ones/usr/local/lib/x,/opt/home-ish/x,C:\Windows\System32,F:\Ship\abcd_xandOneDrive - Personal\Jane\file. The Windows patterns match what they intend.docs-rs.yml, docstring ratio (SC2126, SC2046).wc -l | tr -d ' 'becomesawk 'END { print NR }'(same count, same exit status underpipefail, nogrep | wc -lshape). The$(find ... | grep -v ...)argument list becomesmapfile -t SOURCES < <(...)and"${SOURCES[@]}", with the same files in the same order (the job runs onubuntu-latest, bash 5). The step's script, extracted fromorigin/mainand from this branch and run in the worktree, prints the same four lines:This workflow runs on pull requests, so the job on this PR runs the edited script.
release.yml,publish-pypi(if: false). The gate stays off. The job's condition is nowgithub.event_name == 'disabled', which no trigger of this workflow can satisfy (it runs on tag pushes andworkflow_dispatch, and no event has that name); the comment above the job says why and what to replace it with when PyO3 work ships. The job is not removed and its placeholder step is untouched.Docs that described the gate.
RELEASE.md("What's still manual") saidpublish-pypiwas gated off withif: false; it now says the job is gated off by a condition that is never true and why it is not a literalfalse(actionlint flags a constant condition).release.ymlcarries a one-line comment above the condition with the same reason, and the CHANGELOG's maintainer-tooling entry records the change. The older CHANGELOG line that says the job was scaffolded "gated-off" is a historical entry and is left as written.Job names. No
name:line changes in the diff, so the twelve required checks keep their names.Not run locally: the workflows themselves (they need GitHub's runners). The PII guard and docs.rs jobs on this PR exercise the edited scripts.
Source-provenance declaration
By submitting this PR I certify that my contribution does not incorporate executable code from any source whose license is incompatible with Apache-2.0. Specifically:
CLEANROOM.md).dwg-rsis Apache-2.0 and must remain compatible.My contribution is based on:
CLEANROOM.md.See
CLEANROOM.mdfor the full allowed/forbidden source list and the honest scope of what "clean-room" means for this project.Developer Certificate of Origin
By submitting this PR, I certify that the contribution complies with the
Developer Certificate of Origin 1.1.
Specifically, I affirm that the contribution is my own work (or rightfully
licensed to me) and that it can be distributed under the project's Apache-2.0
license.
I will sign off commits with
git commit -swhen asked, which adds aSigned-off-bytrailer to the commit message asserting the DCO.