🤖 Generated by the Daily AI Assistant
Part of #181.
Problem
CONTRIBUTING.md ships an explicit README template that every per-action README.md is expected to follow:
## Inputs
| Name | Description | Required | Default |
|------|-------------|----------|---------|
## Outputs
| Name | Description |
|------|-------------|
But the per-action READMEs were authored at different times against an evolving template, and there is no automated check that:
- Every
input declared in action.yaml appears in the README's ## Inputs table with matching required + default columns.
- Every
output declared in action.yaml appears in the README's ## Outputs table.
Four actions declare outputs in action.yaml (setup-agent-skills → installed-skills; setup-go-toolchain → go-version; update-agent-skills → changed, updated-skills; upsert-issue → issue-number). Whether each of those is documented matching what's exposed is currently unknown. Same for inputs across all 15 actions. Silent drift is likely — when a new input is added (e.g. setup-agent-skills gaining agents: for multi-agent installs), the README can lag the action.yaml.
Proposed direction
Two-step audit, both in one focused PR:
-
Manual parity audit — read each action's action.yaml and README.md side by side; correct any drift (missing input/output rows, wrong defaults, wrong required flag, stale descriptions). Keep diffs tight — this is a documentation pass, not a refactor.
-
Optional, evaluate during the PR: add a lightweight CI guard so future drift is caught — e.g. a check-readme-parity job that diffs yq-extracted input/output names against grep-extracted README table rows for each action. If the guard adds material complexity for marginal gain, leave it out and capture as a follow-up issue rather than blocking the audit on tooling.
Acceptance criteria
Out of scope
- Rewriting per-action READMEs for style; this is a parity audit, not a copy edit.
- Touching the README template in
CONTRIBUTING.md (unless the audit reveals a structural issue with the template itself, in which case open a follow-up — don't bundle).
- Cross-repo audits (e.g. checking
reusable-workflows workflow_call inputs vs their README) — that's a separate roadmap item if/when warranted.
Labels
documentation.
Part of #181.
Problem
CONTRIBUTING.mdships an explicit README template that every per-actionREADME.mdis expected to follow:But the per-action READMEs were authored at different times against an evolving template, and there is no automated check that:
inputdeclared inaction.yamlappears in the README's## Inputstable with matchingrequired+defaultcolumns.outputdeclared inaction.yamlappears in the README's## Outputstable.Four actions declare outputs in
action.yaml(setup-agent-skills→installed-skills;setup-go-toolchain→go-version;update-agent-skills→changed,updated-skills;upsert-issue→issue-number). Whether each of those is documented matching what's exposed is currently unknown. Same for inputs across all 15 actions. Silent drift is likely — when a new input is added (e.g.setup-agent-skillsgainingagents:for multi-agent installs), the README can lag theaction.yaml.Proposed direction
Two-step audit, both in one focused PR:
Manual parity audit — read each action's
action.yamlandREADME.mdside by side; correct any drift (missing input/output rows, wrong defaults, wrong required flag, stale descriptions). Keep diffs tight — this is a documentation pass, not a refactor.Optional, evaluate during the PR: add a lightweight CI guard so future drift is caught — e.g. a
check-readme-parityjob that diffsyq-extracted input/output names against grep-extracted README table rows for each action. If the guard adds material complexity for marginal gain, leave it out and capture as a follow-up issue rather than blocking the audit on tooling.Acceptance criteria
README.mdhas an## Inputstable that lists every input declared in itsaction.yaml, with matchingrequiredanddefaultcolumns.outputs:in itsaction.yaml(setup-agent-skills,setup-go-toolchain,update-agent-skills,upsert-issue— verify the list during the PR) has an## Outputstable that lists each output with a description.actionlint-clean and pass first try on every action.Out of scope
CONTRIBUTING.md(unless the audit reveals a structural issue with the template itself, in which case open a follow-up — don't bundle).reusable-workflowsworkflow_callinputs vs their README) — that's a separate roadmap item if/when warranted.Labels
documentation.