Skip to content

Commit fa98c4d

Browse files
committed
docs: add release automation docs
1 parent 94d05d6 commit fa98c4d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/release.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Release automation (summary)
2+
3+
Releases are produced by `googleapis/release-please-action` in `.github/workflows/release.yml`.
4+
5+
- Trigger: push to `main`.
6+
- Behavior: `googleapis/release-please-action` parses Conventional Commits and will open/update Release PRs or create a release when appropriate; it also generates/updates the changelog (`CHANGELOG.md`) and exposes outputs such as `release_created`, `major`, `minor`, `patch`, `tag_name`, and `body`.
7+
- CI integration: the workflow uses those outputs to tag versions and to build/push container images (see the repo's workflow for the exact steps).
8+
9+
## Notes for maintainers
10+
11+
- Review the draft release or Release PR produced by the action, add concise highlights or migration notes, then publish/merge.
12+
- Do not commit a handwritten `CHANGELOG.md` to the repository; rely on per-release notes generated by the action.

0 commit comments

Comments
 (0)