Skip to content

Commit 6b85fe0

Browse files
Copilotpelikhan
andauthored
fix: update install script header and contributing release process docs
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/a0752374-80c2-45a1-8e43-97d35023c7cf Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
1 parent 0dfd22f commit 6b85fe0

3 files changed

Lines changed: 30 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -545,6 +545,8 @@ This project follows the GitHub Community Guidelines. Please be respectful and i
545545
546546
Releases are triggered manually by a core team member using the GitHub Actions release workflow.
547547

548+
> **Note:** The release workflow publishes the new version as a **prerelease** on GitHub. Once the release is verified, a maintainer must **manually promote it to a full release and move the `latest` tag** so that users installing with `version: latest` receive the new version.
549+
548550
### Steps
549551

550552
1. **Launch the release action**
@@ -563,7 +565,17 @@ Releases are triggered manually by a core team member using the GitHub Actions r
563565

564566
3. **Approve the environment gate**
565567

566-
Return to the paused release run in [`github/gh-aw`](https://github.com/github/gh-aw/actions). Approve the **`gh-aw-actions-release`** environment gate. The workflow will verify that the new tag exists in `github/gh-aw-actions` and then publish the GitHub release.
568+
Return to the paused release run in [`github/gh-aw`](https://github.com/github/gh-aw/actions). Approve the **`gh-aw-actions-release`** environment gate. The workflow will verify that the new tag exists in `github/gh-aw-actions` and then publish the GitHub release as a **prerelease**.
569+
570+
4. **Promote to latest** _(manual step)_
571+
572+
After verifying the prerelease is working correctly:
573+
574+
a. **Edit the GitHub release** — go to the [Releases page](https://github.com/github/gh-aw/releases), open the new prerelease, uncheck **This is a pre-release**, and save. This promotes the release to a stable full release.
575+
576+
b. **Move the `latest` tag** — GitHub's release API resolves `latest` to the most recent non-prerelease release. Promoting the release in step (a) is sufficient for the `latest` resolution to update automatically.
577+
578+
Users who install with `version: latest` (the default) will now receive the new release.
567579

568580
### Summary
569581

@@ -583,7 +595,13 @@ Merge the sync-actions PR
583595
Approve the gh-aw-actions-release environment gate
584596
585597
586-
Release published 🎉
598+
Release published as prerelease 🎉
599+
600+
▼ (manual)
601+
Promote prerelease → full release on GitHub Releases page
602+
603+
604+
'latest' now resolves to the new version ✅
587605
```
588606

589607
## 🎯 Why This Contribution Model?

actions/setup-cli/install.sh

Lines changed: 5 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

install-gh-aw.sh

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
# Script to download and install gh-aw binary for the current OS and architecture
44
# Supports: Linux, macOS (Darwin), FreeBSD, Windows (Git Bash/MSYS/Cygwin)
5-
# Usage: ./install-gh-aw.sh [version] [options]
65
# If no version is specified, it will use "latest"
76
# Note: Checksum validation is currently skipped by default (will be enabled in future releases)
87
#
8+
# Usage: ./install.sh [version] [options]
9+
#
910
# Examples:
10-
# ./install-gh-aw.sh # Install latest version
11-
# ./install-gh-aw.sh v1.0.0 # Install specific version
12-
# ./install-gh-aw.sh --skip-checksum # Skip checksum validation
11+
# ./install.sh # Install latest version
12+
# ./install.sh v1.0.0 # Install specific version
13+
# ./install.sh --skip-checksum # Skip checksum validation
1314
#
1415
# Options:
1516
# --skip-checksum Skip checksum verification

0 commit comments

Comments
 (0)