Skip to content

docs: update release runbook with clarifications #289

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.

Sign up for GitHub

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

Closed
ryantanner wants to merge 1 commit into from
Closed

docs: update release runbook with clarifications #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions RELEASE-RUNBOOK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ This Gradle task updates all demo app `gradle.properties` files to match the `VE

## Prerequisites for Release Managers

> NOTE: All release tasks should be run from your local machine and not a workspace.

### Required Tools

**GitHub CLI (`gh`)**
Expand Down Expand Up @@ -86,6 +88,7 @@ Verify you have access to:
- Viaduct-GraphQL GitHub organization ([https://github.com/orgs/viaduct-dev/people](https://github.com/orgs/viaduct-dev/people))
- Gradle Plugin Portal `viaduct-maintainers` account (check: https://plugins.gradle.org/u/viaduct-maintainers)
- 1Password vault with `viaductbot` credentials (for Sonatype)
- Write permissions on the [airbnb/viaduct](https://github.com/airbnb/viaduct) repository

If you're missing any access, contact your team lead before release day.

Expand All @@ -103,7 +106,7 @@ Expected output: `Hi <username>! You've successfully authenticated, but GitHub d
If this fails:

- Ensure you have SSH keys set up: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
- Add your key to ssh-agent: `ssh-add ~/.ssh/id_rsa`
- Add your key to ssh-agent: `ssh-add ~/.ssh/id_rsa` or `ssh-add ~/.ssh/id_ed25519`

**Authenticate GitHub CLI**

Expand All @@ -115,7 +118,6 @@ gh auth login
- Select: `HTTPS`
- Authenticate via browser when prompted


**Clone public Viaduct repository:**

Clone to a separate directory (not inside Treehouse):
Expand Down Expand Up @@ -176,6 +178,8 @@ You should see that the `VERSION` file has changed a the project root and the `g

### 3) Make release branch

This step should be done on the main Viaduct repository, not a fork.

Once this PR is approved and merged:

- Create a branch off the SHA just before the version bump. This branch should be named `release/v0.X.0`.
Expand Down
Loading