Repository navigation
🤖 Create GitHub Agentic Workflows Guide #13537
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,184 @@ | ||||||
| # Creating Agentic Workflows and Other Actions | ||||||
|
|
||||||
| This prompt guides you, a coding agent, to create, debug, update or do other actions related to **GitHub Agentic Workflows (gh-aw)** in a repository. | ||||||
|
|
||||||
| ## Step 1: Install GitHub Agentic Workflows CLI Extension | ||||||
|
|
||||||
| Run the installation script from the main branch of the gh-aw repository: | ||||||
|
|
||||||
| ```bash | ||||||
| curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash | ||||||
| ``` | ||||||
|
|
||||||
| **What this does**: Downloads and installs the gh-aw binary to `~/.local/share/gh/extensions/gh-aw/` | ||||||
|
|
||||||
| **Verify installation**: | ||||||
|
|
||||||
| ```bash | ||||||
| gh aw version | ||||||
| ``` | ||||||
|
|
||||||
|
|
||||||
| If already installed, you can update to the latest version by running | ||||||
|
|
||||||
| ```bash | ||||||
| gh extension upgrade gh-aw | ||||||
| ``` | ||||||
|
|
||||||
| You should see version information displayed. If you encounter an error, check that: | ||||||
|
|
||||||
| - GitHub CLI (`gh`) is installed and authenticated | ||||||
| - The installation script completed without errors | ||||||
| - `~/.local/share/gh/extensions` is in your PATH | ||||||
|
||||||
| - `~/.local/share/gh/extensions` is in your PATH | |
| - `~/.local/share/gh/extensions` is in your PATH only if you want to run the `gh-aw` binary directly (not required for using `gh aw ...`, which `gh` discovers automatically) |
Copilot
AI
Feb 3, 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 prompt link uses a github.com/.../blob/... URL, which returns HTML. For an agent that needs to “fetch and read” the prompt content, use a raw URL (raw.githubusercontent.com) or add ?plain=1 to ensure the fetched content is the markdown source, not the GitHub page wrapper.
This issue also appears in the following locations of the same file:
- line 52
- line 64
- line 76
- line 88
Copilot
AI
Feb 3, 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.
This implies every workflow change results in both a .md and a .lock.yml, but shared workflow components (and some edit-only changes to the markdown body) may not produce or require a lock file. Consider qualifying this to “for compiled workflows with frontmatter changes” and note that shared components typically don’t have .lock.yml outputs.
Copilot
AI
Feb 3, 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.
This section says to not commit any init-generated files (like .github/aw/..., .github/agents/..., .vscode/...). That conflicts with gh aw init being an explicit repo setup mechanism and may leave the repo in a partially-initialized state. Consider rewording to: either don’t run gh aw init (and ensure it didn’t create extra files), or if you did run it intentionally, commit the generated initialization files (or revert them) based on the repo’s desired setup.
Copilot
AI
Feb 3, 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 example commit message "Initialize repository for GitHub Agentic Workflows" doesn’t match the described change here (adding/editing specific workflow files). Suggest using a workflow-specific message (and reserving “initialize repository” for when gh aw init is actually performed).
| git commit -m "Initialize repository for GitHub Agentic Workflows" | |
| git commit -m "Add <workflow-name> GitHub Agentic Workflow" |
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 standalone installer (
curl ... | bash) installs a binary into the extensions directory but does not create a git-based extension checkout, sogh extension upgrade gh-awwill generally not work afterwards. Recommend either (a) usinggh extension install github/gh-awas the primary install path and keeping the curl installer as a fallback, or (b) for standalone installs, instruct users to re-run the installer to update (optionally pinned to a version).If you installed via the standalone script above, re-run the same install command:
curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash