-
Notifications
You must be signed in to change notification settings - Fork 312
docs: document --action-tag and --actions-repo compile flags for testing against alternate actions repos #22607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -110,6 +110,30 @@ make golint-incremental BASE_REF=origin/main # 50-75% faster on PRs | |||||
| ``` | ||||||
| **When to use**: Testing individual workflow compilation. | ||||||
|
|
||||||
| #### Compile against a different actions repository | ||||||
|
|
||||||
| When developing changes to `github/gh-aw-actions`, compile workflows against your fork or branch before the changes are released: | ||||||
|
|
||||||
| ```bash | ||||||
| # Compile against a fork with a specific branch or SHA | ||||||
| ./gh-aw compile --action-mode action \ | ||||||
| --actions-repo myorg/my-aw-actions \ | ||||||
| --action-tag my-feature-branch \ | ||||||
| .github/workflows/my-workflow.md | ||||||
|
|
||||||
| # Compile against the default repo pinned to a specific SHA | ||||||
| ./gh-aw compile --action-mode action \ | ||||||
| --action-tag abc123def456 \ | ||||||
|
||||||
| --action-tag abc123def456 \ | |
| --action-tag 0123456789abcdef0123456789abcdef01234567 \ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -253,6 +253,9 @@ Pre-activation runs checks sequentially. Any failure sets `activated=false`, pre | |||||
| | `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`) | | ||||||
|
||||||
| | `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
AI
Mar 24, 2026
There was a problem hiding this comment.
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) | |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 likevX.Y.Z) will make the docs copy/paste-safe.