Skip to content

Commit 1194bed

Browse files
committed
docs: add release process guidelines for maintainers
1 parent 63c419d commit 1194bed

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/contributing.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,46 @@ def store(self, key: str) -> None:
128128
./scripts/test
129129
```
130130

131+
## Releasing (Maintainers Only)
132+
133+
This section is for maintainers who have permissions to publish new releases.
134+
135+
### Release Process
136+
137+
1. **Update the version** in `pyproject.toml`:
138+
```toml
139+
[project]
140+
version = "1.1.6" # Update to new version
141+
```
142+
143+
2. **Generate the changelog** using `git cliff`:
144+
```bash
145+
git cliff --output CHANGELOG.md 0.1.3.. --tag 1.1.6
146+
```
147+
- Start from `0.1.3` (versions before this didn't use conventional commits)
148+
- Specify the new release tag with `--tag`
149+
150+
3. **Commit the changes** with an unconventional commit message:
151+
```bash
152+
git add pyproject.toml CHANGELOG.md
153+
git commit -m "Version 1.1.6"
154+
```
155+
156+
4. **Create a git tag** for the release:
157+
```bash
158+
git tag 1.1.6
159+
```
160+
161+
5. **Push to GitHub** (both commits and tags):
162+
```bash
163+
git push
164+
git push --tags
165+
```
166+
167+
6. **Ensure CI passes** - Wait for all GitHub Actions workflows to complete successfully
168+
169+
7. **Done!** - The release is published once CI passes
170+
131171
## Questions?
132172

133173
If you have questions about contributing, feel free to:

0 commit comments

Comments
 (0)