Skip to content

Commit 3ac4418

Browse files
committed
docs: document local actionlint validation
1 parent 625531c commit 3ac4418

3 files changed

Lines changed: 33 additions & 4 deletions

File tree

.agents/agents/review-guardian.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ and generated-output drift before human review time is spent.
2727
surfaces when touched.
2828
- Require explicit validation evidence for workflow, local-action, and
2929
packaged-wrapper changes. Prefer deterministic local harnesses, fake
30-
``gh``/``git`` scripts, temporary repositories, shell/YAML checks, or a
31-
temporary validation PR when GitHub-only behavior cannot be exercised locally.
30+
``gh``/``git`` scripts, temporary repositories, ``actionlint`` for workflows,
31+
shell/YAML checks, or a temporary validation PR when GitHub-only behavior
32+
cannot be exercised locally.
3233
- When a workflow pushes commits with ``GITHUB_TOKEN``, verify that required
3334
checks are dispatched or mirrored for the bot-authored commit before treating
3435
the workflow as safe.

.agents/skills/pull-request-review/references/workflow-action-validation.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Validation Strategies
4545
Prefer deterministic local validation when it can cover the changed behavior:
4646

4747
- run ``bash -n`` for shell scripts;
48-
- parse changed YAML files or run ``actionlint`` when available;
48+
- parse changed YAML files or run ``actionlint`` after ensuring it is available;
4949
- use fake ``gh`` and ``git`` wrappers to exercise action scripts without
5050
calling GitHub;
5151
- create temporary Git repositories to validate merge, rebase, conflict,
@@ -54,6 +54,34 @@ Prefer deterministic local validation when it can cover the changed behavior:
5454
- verify packaged wrapper inputs, permissions, and reusable workflow paths stay
5555
aligned with the canonical workflow.
5656

57+
Actionlint Availability
58+
-----------------------
59+
60+
When workflow files are changed, prefer running ``actionlint`` locally. If it is
61+
missing, install it before review when the platform has a safe package manager:
62+
63+
- macOS with Homebrew: ``brew install actionlint``;
64+
- macOS with MacPorts: ``sudo port install actionlint``;
65+
- Debian-based Linux: download the official ``actionlint`` release archive for
66+
the host architecture, unpack the binary into a temporary directory, and run
67+
it from there or install it into a user-local ``PATH`` such as
68+
``~/.local/bin``.
69+
70+
``actionlint`` is distributed as a Go binary. It may use ``shellcheck`` for
71+
``run:`` blocks, and Homebrew installs that dependency automatically. On
72+
Windows, prefer WSL for now unless the repository already documents a native
73+
Windows installation path.
74+
75+
Use the broadest relevant command for the changed surfaces, for example:
76+
77+
.. code-block:: bash
78+
79+
actionlint .github/workflows/*.yml resources/github-actions/*.yml
80+
81+
Record the command and result in the review evidence. If installation is not
82+
possible, record that as a residual validation gap instead of silently skipping
83+
workflow linting.
84+
5785
When local simulation cannot cover the behavior, call out the gap and prefer a
5886
temporary validation branch or pull request. Close that validation PR after
5987
recording the evidence in the real PR or issue. Do not require noisy temporary

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Added
1111

1212
- Auto-resolve pull-request conflicts limited to workflow-managed `.github/wiki` pointers and `CHANGELOG.md` `Unreleased` drift (#192)
13-
- Teach the pull-request review skill, review-guardian agent, and review request brief to require explicit validation strategies for workflow, local-action, and packaged-wrapper changes (#241)
13+
- Teach the pull-request review skill, review-guardian agent, and review request brief to require explicit validation strategies for workflow, local-action, and packaged-wrapper changes, including local `actionlint` installation guidance (#241)
1414

1515
### Fixed
1616

0 commit comments

Comments
 (0)