You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,22 +19,23 @@ MAJOR.MINOR.PATCH
19
19
1.**Update the Version**
20
20
Decide whether the changes are major, minor, or patch increments.
21
21
22
-
2.**Update the Changelog**
23
-
Move your entries from the **[Unreleased]** section in `CHANGELOG.md` to a new version heading with today’s date (e.g., `## [0.2.0] - 2025-02-20`).
24
-
25
-
3.**Create a Release Branch**
26
-
-`release-v0.2.0` or similar (e.g., `release-v0.2.0-beta.1` for beta versions).
27
-
28
-
4.**Run Tests**
22
+
2.**Run Tests**
29
23
- Ensure all tests pass locally (run `pytest`).
30
24
- Confirm CI passes (integration tests, etc.).
31
25
32
-
5.**Merge into `main`**
33
-
- Create a Pull Request from `release-vX.X.X` into `main`.
34
-
- Wait for code review, ensure everything is green.
26
+
3.**Tag the Release**
27
+
Once the release changes are merged, create and push a git tag that matches the publish workflow trigger (`v*.*.*`):
35
28
36
-
6.**Tag the Release**
37
-
Once merged, create a git tag with the new version:
38
29
```bash
39
30
git tag -a v0.2.0 -m "Release 0.2.0"
40
31
git push origin v0.2.0
32
+
```
33
+
34
+
4.**Monitor the Publish Workflow**
35
+
- The `.github/workflows/publish.yml` workflow runs automatically when the tag is pushed.
36
+
- The workflow builds the source distribution and wheel, generates protobufs before packaging, signs the release artifacts with Sigstore, publishes the package to PyPI, and creates or updates the GitHub release.
37
+
38
+
5.**Verify Published Artifacts**
39
+
- Confirm the new version is available on PyPI.
40
+
- Confirm the GitHub release contains the wheel, source distribution, and matching `.sigstore.json` bundles.
41
+
- If release provenance needs to be audited, use the Sigstore verification materials attached to the GitHub release.
0 commit comments