Skip to content

Commit e40956d

Browse files
AakashAakash
authored andcommitted
chore: document release process
1 parent 7b5f5d3 commit e40956d

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

RELEASES.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Release Management
2+
3+
This project uses conventional commits, release-please, and CI to automate versions, changelog entries, and Docker image tagging. Keep commit and PR titles conventional so automation can do its job.
4+
5+
## How releases work
6+
- **Conventional commits** (and PR titles) drive version bumps: `feat` → minor, `fix`/`chore` → patch, `BREAKING CHANGE` → major.
7+
- **Release-please** runs on `main` and opens a release PR (e.g., `release-please--branches--main`) with:
8+
- Updated `CHANGELOG.md`
9+
- Bumped versions in `package.json`/lockfile
10+
- A tag proposal (e.g., `v0.1.0`)
11+
- **Merging the release PR**:
12+
- Creates the Git tag and GitHub Release.
13+
- Triggers the Docker workflow to build and push images with semver tags (and `latest` when applicable).
14+
15+
## Contributor guidelines
16+
- Use conventional commit messages and PR titles.
17+
- Keep user-facing changes documented so release notes are accurate.
18+
- CI will fail on non-conventional commit/PR titles.
19+
20+
## Admin notes for release PRs
21+
- Release PRs are opened by release-please on `main`.
22+
- You can edit the release PR description and changelog entries before merging.
23+
- If you need a different version, adjust the release PR (e.g., change the version bump) before merge.
24+
- Once merged, tags and releases are created automatically; Docker images are pushed with the new version.

0 commit comments

Comments
 (0)