Skip to content

Commit 677a2bd

Browse files
committed
fix: document release flow
1 parent 7399bb3 commit 677a2bd

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

.github/workflows/verify-release-tag.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77

88
jobs:
99
check:
10+
if: startsWith(github.ref, 'refs/tags/')
1011
name: Ensure Tag Matches Module
1112
runs-on: ubuntu-latest
1213
steps:

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,13 @@ The [`docs/`](docs/overview.md) directory contains more detailed usage and toolc
3838
- Go (cobra CLI with transitive deps): [`examples/go_complex`](examples/go_complex/BUILD.bazel)
3939
- Node.js (basic): [`examples/node`](examples/node/BUILD.bazel)
4040
- Node.js (express app with transitive deps): [`examples/node_complex`](examples/node_complex/BUILD.bazel)
41+
42+
## Release workflow
43+
44+
Releases are automated with Release Please. Conventional commits drive the next version:
45+
46+
- `feat:` bumps the minor version while we are pre-1.0.
47+
- `fix:` (or other non-feature commits) bumps the patch version.
48+
- Commits with `BREAKING CHANGE:` or a `!` trigger a major bump.
49+
50+
Once changes land on `main`, the GitHub action opens a release PR. Merging that PR tags `vX.Y.Z`, publishes the GitHub release, and the `Verify Release Tag` workflow confirms that the tag matches the version declared in `MODULE.bazel`.

0 commit comments

Comments
 (0)