Skip to content

Commit

Permalink
RELEASING.md release process documentation (#322)
Browse files Browse the repository at this point in the history
Signed-off-by: pdewilde <[email protected]>
  • Loading branch information
pdewilde authored Mar 22, 2024
1 parent 4e63bdb commit f566650
Showing 1 changed file with 29 additions and 0 deletions.
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.

0 comments on commit f566650

Please sign in to comment.