Repository navigation
ci: fix shellcheck findings and trim workflow comments (#1967) - #2023
Conversation
JarryShaw
added
ci
|
GOOD TO GO at A Sonnet cross-review confirmed:
Two calls for you:
Conflicts: one |
JarryShaw
added
review: good-to-go
|
resolve conflicts |
6f0b8dc to
4ae58a4
Compare
|
Rebased onto The only conflict was in Locally, 48 workflow and docs pin modules gave 1120 passed. actionlint still flags only the |
|
Project tests failed again. |
|
That run was on |
|
Coverage: 91.54% (unit tier, Python 3.15,
Per-file detail: the |
|
Ordering check for this PR, since the "Plain unittest ordering" job is skipped on PRs: on |
|
resolve conflicts |
Step 5, part 1 of #1967, over every workflow except unit-tests.yml and experimental.yml (open PRs edit those): - Fix actionlint's shellcheck findings at the root: quote the `.[extras]` pip targets (SC2102), group `$GITHUB_OUTPUT` writes into one quoted redirect (SC2129, SC2086), quote `exit "$status"` (SC2086), and run isort through `find ... -exec ... {} +` instead of an unquoted `$(find)` (SC2046). - Trim comments: drop restatements of the YAML, history narration, duplicated rationale, CodeQL template boilerplate and dead commented-out keys; keep each non-obvious why and its issue ref. - Cite create-release.yml, python-compatibility.yml and coverage-comment.yml by job and step name in releasing.rst and workflows.rst (decision A), and replace the line-anchor test with one that rejects line-number citations of those files. - Update the conda pin test for the quoted `'.[all]'`. actionlint 1.7.12 now reports nothing outside unit-tests.yml.
aa8d165 to
b813b23
Compare
|
Rebased onto |
|
Ordering check on |
JarryShaw
removed
the
review: good-to-go
- lint.yml: drop the actionlint step's `continue-on-error`, so a finding fails Lint; move it below the advisory steps and run it on `!cancelled()` so a finding skips none of them and a failed setup does not skip it. Version and sha256 pin unchanged. - lint.yml: the step's comment says it blocks, why that is safe now (#2023, #2037, #2038), and that the image's shellcheck can drift. - workflows.rst: Workflow Lint no longer calls the step advisory. - test_actionlint_in_lint_1967: TestItBlocks pins the blocking shape; test_unit_tests_shellcheck_1967's docstring no longer says advisory.
- lint.yml: drop the actionlint step's `continue-on-error`, so a finding fails Lint; move it below the advisory steps and run it on `!cancelled()` so a finding skips none of them and a failed setup does not skip it. Version and sha256 pin unchanged. - lint.yml: the step's comment says it blocks, why that is safe now (#2023, #2037, #2038), and that the image's shellcheck can drift. - workflows.rst: Workflow Lint no longer calls the step advisory. - test_actionlint_in_lint_1967: TestItBlocks pins the blocking shape; test_unit_tests_shellcheck_1967's docstring no longer says advisory.
- lint.yml: drop the actionlint step's `continue-on-error`, so a finding fails Lint; move it below the advisory steps and run it on `!cancelled()` so a finding skips none of them and a failed setup does not skip it. Version and sha256 pin unchanged. - lint.yml: the step's comment says it blocks, why that is safe now (#2023, #2037, #2038), and that the image's shellcheck can drift. - workflows.rst: Workflow Lint no longer calls the step advisory. - test_actionlint_in_lint_1967: TestItBlocks pins the blocking shape; test_unit_tests_shellcheck_1967's docstring no longer says advisory.
- lint.yml: drop the actionlint step's `continue-on-error`, so a finding fails Lint; move it below the advisory steps and run it on `!cancelled()` so a finding skips none of them and a failed setup does not skip it. Version and sha256 pin unchanged. - lint.yml: the step's comment says it blocks, why that is safe now (#2023, #2037, #2038), and that the image's shellcheck can drift. - workflows.rst: Workflow Lint no longer calls the step advisory. - test_actionlint_in_lint_1967: TestItBlocks pins the blocking shape; test_unit_tests_shellcheck_1967's docstring no longer says advisory.
- lint.yml: drop the actionlint step's `continue-on-error`, so a finding fails Lint; move it below the advisory steps and run it on `!cancelled()` so a finding skips none of them and a failed setup does not skip it. Version and sha256 pin unchanged. - lint.yml: the step's comment says it blocks, why that is safe now (#2023, #2037, #2038), and that the image's shellcheck can drift. - workflows.rst: Workflow Lint no longer calls the step advisory. - test_actionlint_in_lint_1967: TestItBlocks pins the blocking shape; test_unit_tests_shellcheck_1967's docstring no longer says advisory.
make pylint,make mypy,make isort)make testpasses, and a test case covers the changedocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseDescription of your pull request and other information
Step 5, part 1 of #1967, over every workflow except
unit-tests.ymlandexperimental.yml(#2006, #2021 and #2022 edit those).unit-tests.ymlfixed at its root — quoted'.[extras]'(SC2102), one quoted{ ...; } >> "$GITHUB_OUTPUT"group (SC2129/SC2086),exit "$status",find ... -exec isort ... {} +for the unquoted$(find)(SC2046). No disables. actionlint 1.7.12 now reports onlyunit-tests.yml's fixture-tier step (SC2086), left for part 2.#NNNkept. Parsed YAML is unchanged apart from the shellcheck edits.releasing.rstandworkflows.rstcitecreate-release.yml,python-compatibility.ymlandcoverage-comment.ymlby job and step name; a new test rejects line-number citations of them, replacing the line-anchor table.Tests: the
tests/projectmodules reading these workflows and docs pass (1112 passed, 5 skipped).make testnot run. Refs #1967.