Skip to content

Commit ef9a767

Browse files
author
Joris Conijn
authored
chore: update release process with new insights (#32)
Update the process. Issue: #20
1 parent 0df7bd3 commit ef9a767

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,18 @@ reported the issue. Please try to include as much information as you can.
1919
First you will need to update the `version` in the [`pyproject.toml`](./pyproject.toml) file. Next you need to merge the
2020
change to the `main` branch using a pull request.
2121

22+
Lookup the generated release notes, they are listed as draft. Copy them to a temporary file for later use.
23+
2224
Then you need to create a new release. You can do this by creating a tag and push it to the remote:
2325

2426
```bash
2527
git tag v$(awk '/version/{print $NF}' pyproject.toml | sed 's/\"//g')
2628
git push --tags
2729
```
2830

29-
This will trigger the GitHub Actions [`release`](.github/workflows/release.yml) workflow.
31+
This will trigger the GitHub Actions [`release`](.github/workflows/release.yml) workflow.
32+
33+
Create a pull request from `develop` to `main` and merge it. Go to the releases section on GitHub and update the new
34+
release with the previously stored release notes.
35+
36+
All done!

0 commit comments

Comments
 (0)