docs(workflows): document all reusable workflows and drop phantom entry - #70
Conversation
There was a problem hiding this comment.
Documentation is accurate and complete. Verified all 16 workflow files now have matching README sections (no phantom ci-go-action.yml, no missing entries), and every documented input/default/job name matches the corresponding workflow_call block for the six new sections. Left two minor, non-blocking nits (a slightly incomplete security-config description that omits the always-on Trivy config scan, and a Jobs-list consistency suggestion). Nothing blocking.
7cfd81a to
dad7783
Compare
There was a problem hiding this comment.
Thanks for the update — the security-config.yml description is now clear about the always-on Trivy scan. One nit remains: release-go.yml and security-code.yml sections in the README still have no Jobs: list, while the other four sections added in this PR do. Please add them for consistency.
|
Thanks — the first nit was a real gap and is fixed. On the Jobs: lists for
The four pre-existing ones were not touched by this PR. Multi-job sections added here ( Adding the lists would make these two the only single-job sections in the file with one — a single-item list restating the heading. Happy to add them if the preference is to list jobs everywhere, but that should be a separate change covering all six for real consistency. |
The README documented `ci-go-action.yml`, which does not exist — copying that block yields a workflow resolution error — while six actual reusables were missing entirely. All sixteen workflows are now documented from their `workflow_call` inputs. Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
The `release-go.yml` and `security-code.yml` sections were the only ones without a **Jobs:** list, which review feedback flagged as inconsistent with the four sections added alongside them. Job names are taken from the workflow files rather than inferred: `goreleaser`, and `analyze` as a matrix over the `languages` input. The rebase onto main brought in the three `self-*` workflows from #71, which this README did not cover. They are deliberately absent from the reusable sections above — they carry no `workflow_call` trigger and cannot be called from another repository — so they get a short section of their own stating that, rather than being listed as if consumers could use them. Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
dad7783 to
646f794
Compare
There was a problem hiding this comment.
All raised issues have been addressed. The Jobs sections are now present for all workflow entries in the README including release-go and security-code. The three new self-* workflows look correct: self-merge.yml serializes tag moves with cancel-in-progress false and guards forward-only with an ancestry check; self-pull-request.yml and self-weekly-security.yml use appropriate minimal permissions. The .review-base/ sparse-checkout fix in ai-claude-review.yml is a solid security improvement. One cosmetic nit not worth blocking on: self-merge.yml annotates the checkout SHA as v7.0.1 while every other workflow uses v7 for the same SHA — harmless since Renovate tracks the SHA, but worth normalizing.
Summary
ci-go-action.ymlsection: the file does not exist, so copying its usage block produces a workflow resolution error. Its content described jobs now split acrossci-lint.ymlandci-go.yml.ci-go.yml,ci-lint.yml,release-go.yml,security-code.yml,security-config.yml,security-sbom.yml. Inputs and jobs are taken from each file'sworkflow_callsection, following the existingsecurity-trivy.ymlformat..github/workflows/are now documented, resolving the contradiction withAGENTS.md, which already listed them correctly.Test plan
*.ymlhas a matching####section in the README (no missing entries)workflow_call.inputsfor all six new sections