Skip to content
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.

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

RELEASING.md release process documentation #322

Merged
merged 1 commit into from
Mar 22, 2024
Merged
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Release Guide For Team Members

## Process

1. Merge any changes you want to include into `main`.
2. Run
the [`draft-release`](https://github.com/abcxyz/pkg/actions/workflows/draft-release.yml)
workflow. Run from the main branch. Choose what sort
of [semantic versoning](https://semver.org)
increment you want to make (Major, Minor, Patch, Prerelease).
3. Approve the `PR` created by `draft-release`. Once `PR` is merged
the `release`
workflow will automatically run.
4. Optional: Edit description at https://github.com/abcxyz/pkg/releases

### Patching Old Versions

Currently, you can only increment an existing version on the main branch.
There is currently no automated way to make a patch of an old release, and
doing so must be done by manually tagging and releasing.

### `VERSION` File

`VERSION` in the root of the repo is used by `draft-release` to determine the
"current" version to increment from. It must be a valid existing tag.

#### Failed Release
If a release fails, you will need to manually decrement the `VERSION` file
to its previous state before running `draft-release` again to create a new PR.