docs: add Releases and Versioning reference page#23635
Conversation
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/696b9807-1b99-4e5e-83e0-b779d5a763f8 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/696b9807-1b99-4e5e-83e0-b779d5a763f8 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new reference page documenting gh-aw release channels/versioning behavior and surfaces it in the docs sidebar, plus a small correction in the Agent Factory status table.
Changes:
- Added
Releases and Versioningreference page covering release channels, compiled workflow version enforcement, lock-file pinning, andupgradevsupdate. - Added a Reference sidebar entry for the new page.
- Updated the Agent Factory status table to reflect the CI Failure Doctor engine as
codex.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/content/docs/reference/releases.md | New reference documentation for release channels, lock/version enforcement, and command semantics. |
| docs/src/content/docs/agent-factory-status.mdx | Updates the CI Failure Doctor “Agent” column value. |
| docs/astro.config.mjs | Adds the new reference page to the sidebar navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| gh extension install github/gh-aw # stable (default) | ||
| gh extension install github/gh-aw@v0.64.5 # pinned version |
There was a problem hiding this comment.
The comment # stable (default) on gh extension install github/gh-aw is misleading. The stable/latest channel aliases are resolved by install-gh-aw.sh via .github/aw/releases.json, but gh extension install does not consult that file (it installs from the default ref / latest release depending on gh). Please reword this example to avoid implying that gh extension install tracks the stable channel (e.g., label it as “default install” and note that channel selection is only supported by the standalone installer).
|
|
||
| ## How Lock Files Are Pinned | ||
|
|
||
| When `gh aw compile` generates a `.lock.yml`, it pins every GitHub Actions reference to a commit SHA: |
There was a problem hiding this comment.
gh aw compile does not always pin every action reference to a commit SHA. In this repo there are compiled workflows that use stable tags like github/gh-aw-actions/setup@v0 when SHA resolution is unavailable (see the Action Pinning section in reference/compilation-process.md). Suggest rephrasing to “tries to pin … typically to a commit SHA, but may fall back to stable tags (e.g., @v0) when it can’t resolve a SHA.”
| When `gh aw compile` generates a `.lock.yml`, it pins every GitHub Actions reference to a commit SHA: | |
| When `gh aw compile` generates a `.lock.yml`, it tries to pin each GitHub Actions reference, typically to a commit SHA, but may fall back to stable tags (for example, `@v0`) when it can't resolve a SHA: |
Summary
Adds
docs/src/content/docs/reference/releases.md— a dedicated reference page for release channels, lock file versioning, and theupgradevsupdatecommands.Changes
New page:
docs/src/content/docs/reference/releases.mdstable(default, resolves via.github/aw/releases.json),latest, and pinned version tags; includes install examples for the shell installer,gh extension install, and thesetup-cliGitHub ActionGH_AW_INFO_AWF_VERSIONis embedded in every.lock.ymland validated at runtime againstblockedVersions,minimumVersion, andminRecommendedVersionactions-lock.jsoncache, and why Dependabot PRs targetinggh-aw-actionslock file references should not be merged manuallyupgradevsupdate— clearly distinguishes the two commands:upgradeupdates repository infrastructure (agent files, codemods, action pins, recompilation), whileupdatefetches workflow markdown content from upstream source repositoriesSidebar entry: Added
{ label: 'Releases and Versioning', link: '/reference/releases/' }to the Reference section indocs/astro.config.mjsVerification
make build-docspasses with no errors and all internal links validated.