Skip to content

Commit b7184ac

Browse files
authored
docs: add release process to CONTRIBUTING.md (#20800)
1 parent a6ff9c1 commit b7184ac

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,53 @@ This project follows the GitHub Community Guidelines. Please be respectful and i
516516
- **For examples**: Look at existing issues and PRs created by core team members
517517
- **Remember**: You don't create PRs - you create issues with plans that a core team member implements using agents
518518

519+
## 🚀 Release Process
520+
521+
> **For core team maintainers only.** Community members do not participate in releasing.
522+
523+
Releases are triggered manually by a core team member using the GitHub Actions release workflow.
524+
525+
### Steps
526+
527+
1. **Launch the release action**
528+
529+
Go to [Actions → Release](https://github.com/github/gh-aw/actions/workflows/release.lock.yml) and click **Run workflow**. Select the release type (`patch`, `minor`, or `major`) and start the run.
530+
531+
The workflow will build the release binaries, push a new git tag, and then pause — waiting for a required manual step before publishing.
532+
533+
2. **Complete the sync in `github/gh-aw-actions`**
534+
535+
While the workflow is paused at the `gh-aw-actions-release` environment gate, complete the following steps in the [`github/gh-aw-actions`](https://github.com/github/gh-aw-actions) repository:
536+
537+
a. **Run the sync-actions workflow** — go to [Actions → sync-actions](https://github.com/github/gh-aw-actions/actions/workflows/sync-actions.yml) and trigger it with the new release tag (e.g. `v1.2.3`).
538+
539+
b. **Merge the PR** — the sync-actions workflow will open a pull request in `github/gh-aw-actions`. Review and merge it to bring the tag into that repository.
540+
541+
3. **Approve the environment gate**
542+
543+
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.
544+
545+
### Summary
546+
547+
```
548+
Launch release action
549+
550+
551+
Workflow pushes tag & pauses
552+
553+
554+
Run sync-actions in github/gh-aw-actions (with new tag)
555+
556+
557+
Merge the sync-actions PR
558+
559+
560+
Approve the gh-aw-actions-release environment gate
561+
562+
563+
Release published 🎉
564+
```
565+
519566
## 🎯 Why This Contribution Model?
520567

521568
This project is built by a core team using agentic development to demonstrate and dogfood the capabilities of GitHub Agentic Workflows:

0 commit comments

Comments
 (0)