Skip to content

docs: document --action-tag and --actions-repo compile flags for testing against alternate actions repos#22607

Merged
pelikhan merged 2 commits intomainfrom
copilot/update-contributing-instructions
Mar 24, 2026
Merged

docs: document --action-tag and --actions-repo compile flags for testing against alternate actions repos#22607
pelikhan merged 2 commits intomainfrom
copilot/update-contributing-instructions

Conversation

Copy link
Contributor

Copilot AI commented Mar 24, 2026

No documentation existed explaining how to use --action-tag and --actions-repo to compile workflows against a fork or branch of github/gh-aw-actions — a common need when developing cross-repo changes.

Changes

  • CONTRIBUTING.md — Added "Compiling against a different actions repository" under Testing with flag descriptions and examples
  • DEVGUIDE.md — Added "Compile against a different actions repository" alongside the existing compile task entries
  • docs/…/compilation-process.md — Added three rows to the Compilation Commands table covering --actions-repo, --action-tag, and their combination; added a [!NOTE] callout clarifying usage

Example

# Compile against a fork on a feature branch
./gh-aw compile --action-mode action \
  --actions-repo myorg/my-aw-actions \
  --action-tag my-feature-branch \
  .github/workflows/my-workflow.md

# Pin to a specific SHA
./gh-aw compile --action-mode action \
  --action-tag abc123def456 \
  .github/workflows/my-workflow.md

--action-mode action is required when using --actions-repo; it switches from inlining scripts locally to referencing actions from the external repository.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.14.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

…-repo compile flags

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/7d49cf5a-0137-49ba-ba51-65365c9ee2a1
Copilot AI changed the title [WIP] Update contributing instructions for compile flags docs: document --action-tag and --actions-repo compile flags for testing against alternate actions repos Mar 24, 2026
Copilot AI requested a review from pelikhan March 24, 2026 05:45
@pelikhan pelikhan marked this pull request as ready for review March 24, 2026 05:49
Copilot AI review requested due to automatic review settings March 24, 2026 05:49
@pelikhan pelikhan merged commit 1ecfd03 into main Mar 24, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/update-contributing-instructions branch March 24, 2026 05:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents how to compile workflows against alternative gh-aw-actions repositories/refs to support cross-repo development and testing.

Changes:

  • Added contributor/developer guide sections describing --actions-repo and --action-tag usage with examples.
  • Extended the docs reference compilation command table and added a note clarifying repository override behavior.
  • Updated the agent factory status table to include the /nit command for the PR Nitpick Reviewer workflow.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
docs/src/content/docs/reference/compilation-process.md Adds compilation command table rows and a note documenting --actions-repo / --action-tag.
docs/src/content/docs/agent-factory-status.mdx Updates the PR Nitpick Reviewer entry to show the /nit command.
DEVGUIDE.md Adds a dev guide section with flags and examples for compiling against a different actions repo.
CONTRIBUTING.md Adds contributor-facing guidance and examples for compiling against a different actions repo.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


# Compile against the default repo pinned to a specific SHA
./gh-aw compile --action-mode action \
--action-tag abc123def456 \
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example uses --action-tag abc123def456, but GitHub Actions refs require a full 40-character commit SHA (short SHAs are not supported reliably). Consider using a full-length SHA in the example (or a tag like vX.Y.Z) to avoid copy/paste failures.

Suggested change
--action-tag abc123def456 \
--action-tag 0123456789abcdef0123456789abcdef01234567 \

Copilot uses AI. Check for mistakes.

# Compile with a specific tag or SHA
./gh-aw compile --action-mode action \
--action-tag abc123def456 \
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example uses a short commit SHA (abc123def456) for --action-tag. GitHub Actions refs generally require a full 40-character commit SHA. Updating the example to a full SHA (or a tag like vX.Y.Z) will make the docs copy/paste-safe.

Suggested change
--action-tag abc123def456 \
--action-tag 0123456789abcdef0123456789abcdef01234567 \

Copilot uses AI. Check for mistakes.
| `gh aw compile --actionlint --zizmor --poutine` | Run security scanners |
| `gh aw compile --purge` | Remove orphaned `.lock.yml` files |
| `gh aw compile --output /path/to/output` | Custom output directory |
| `gh aw compile --action-mode action --actions-repo owner/repo` | Compile using a custom actions repository (requires `--action-mode action`) |
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--actions-repo is only applied when action mode is action; the CLI doesn't appear to hard-require it, it will just be ignored in other modes. Consider rephrasing the description to “only works when --action-mode action is set” (or similar) to avoid implying the command will error without it.

Suggested change
| `gh aw compile --action-mode action --actions-repo owner/repo` | Compile using a custom actions repository (requires `--action-mode action`) |
| `gh aw compile --action-mode action --actions-repo owner/repo` | Compile using a custom actions repository (only applied when `--action-mode action` is set) |

Copilot uses AI. Check for mistakes.
| `gh aw compile --output /path/to/output` | Custom output directory |
| `gh aw compile --action-mode action --actions-repo owner/repo` | Compile using a custom actions repository (requires `--action-mode action`) |
| `gh aw compile --action-mode action --actions-repo owner/repo --action-tag branch-or-sha` | Compile against a specific branch or SHA in a fork |
| `gh aw compile --action-tag v1.2.3` | Pin action references to a specific tag or SHA (implies release mode) |
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table entry says --action-tag ... “implies release mode”, but the CLI behavior is “overrides to release unless --action-mode action is explicitly set” (in which case it stays in action mode). Consider tweaking the wording to reflect that exception so readers don’t assume --action-tag always forces release mode.

Suggested change
| `gh aw compile --action-tag v1.2.3` | Pin action references to a specific tag or SHA (implies release mode) |
| `gh aw compile --action-tag v1.2.3` | Pin action references to a specific tag or SHA (defaults to release mode unless `--action-mode action` is explicitly set) |

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants