Skip to content

Commit 8bc71f3

Browse files
committed
Update release-process
1 parent 66a4886 commit 8bc71f3

File tree

2 files changed

+37
-12
lines changed

2 files changed

+37
-12
lines changed

.changelog/841.trivial.md

Whitespace-only changes.

docs/release-process.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,44 @@
22

33
The following steps are needed to create a release.
44

5-
Create a tag on the commit that should be released:
5+
1. **Generate the Changelog**
6+
- Run the following command to generate the changelog on the `main` branch:
67

7-
```bash
8-
export VERSION=v0.0.1
9-
git tag --sign --message="Version ${VERSION}" "${VERSION}"
10-
```
8+
```bash
9+
make changelog
10+
```
1111

12-
Push the tag upstream:
12+
- Create a new branch for the release:
1313

14-
```bash
15-
git push origin "${VERSION}"
16-
```
14+
```bash
15+
export VERSION=v0.0.1
16+
git checkout -b <user>/release-${VERSION}
17+
```
1718

18-
This will trigger the `release` GitHub Action that will create and publish a
19-
release, together with the changelog with changes since the previous release.
20-
Commit messages are used to generate the changelog.
19+
2. **Review and Update the Changelog**
20+
- Review the generated changelog and make updates if necessary.
21+
- If needed (e.g., for a minor release), manually update the version in
22+
`.punch_version.py` to match the release version.
23+
- Add a `Deployment Notes` section to the changelog, if relevant or needed.
24+
25+
3. **Create and Merge a Pull Request**
26+
- Create a pull request from the `<user>/release-${VERSION}` branch.
27+
- Get the pull request reviewed and merged into `main`.
28+
29+
4. **Pull the Latest Changes**
30+
- Switch to the `main` branch and pull the latest changes:
31+
32+
```bash
33+
git checkout main
34+
git pull
35+
```
36+
37+
5. **Create the Release Tag**
38+
- Run the following command to create the release tag:
39+
40+
```bash
41+
make release-tag
42+
```
43+
44+
- This will trigger the `release` GitHub Action to create and publish the
45+
release, including the changelog with changes since the previous release.

0 commit comments

Comments
 (0)