Skip to content

docs: add Releases and Versioning reference page#23635

Merged
pelikhan merged 3 commits intomainfrom
copilot/add-releases-documentation
Mar 31, 2026
Merged

docs: add Releases and Versioning reference page#23635
pelikhan merged 3 commits intomainfrom
copilot/add-releases-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

Summary

Adds docs/src/content/docs/reference/releases.md — a dedicated reference page for release channels, lock file versioning, and the upgrade vs update commands.

Changes

  • New page: docs/src/content/docs/reference/releases.md

    • Release channels — explains stable (default, resolves via .github/aw/releases.json), latest, and pinned version tags; includes install examples for the shell installer, gh extension install, and the setup-cli GitHub Action
    • Version enforcement in compiled workflows — describes how GH_AW_INFO_AWF_VERSION is embedded in every .lock.yml and validated at runtime against blockedVersions, minimumVersion, and minRecommendedVersion
    • How lock files are pinned — explains SHA-based action pinning, the actions-lock.json cache, and why Dependabot PRs targeting gh-aw-actions lock file references should not be merged manually
    • upgrade vs update — clearly distinguishes the two commands: upgrade updates repository infrastructure (agent files, codemods, action pins, recompilation), while update fetches workflow markdown content from upstream source repositories
  • Sidebar entry: Added { label: 'Releases and Versioning', link: '/reference/releases/' } to the Reference section in docs/astro.config.mjs

Verification

make build-docs passes with no errors and all internal links validated.

Copilot AI and others added 2 commits March 31, 2026 04:05
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>
@pelikhan pelikhan marked this pull request as ready for review March 31, 2026 04:10
Copilot AI review requested due to automatic review settings March 31, 2026 04:10
@pelikhan pelikhan merged commit 40d7156 into main Mar 31, 2026
3 checks passed
@pelikhan pelikhan deleted the copilot/add-releases-documentation branch March 31, 2026 04:11
Copy link
Copy Markdown
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

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 Versioning reference page covering release channels, compiled workflow version enforcement, lock-file pinning, and upgrade vs update.
  • 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.

Comment on lines +35 to +37
```bash
gh extension install github/gh-aw # stable (default)
gh extension install github/gh-aw@v0.64.5 # pinned version
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

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).

Copilot uses AI. Check for mistakes.

## How Lock Files Are Pinned

When `gh aw compile` generates a `.lock.yml`, it pins every GitHub Actions reference to a commit SHA:
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

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.”

Suggested change
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:

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