Skip to content

Commit 7a634ec

Browse files
committed
Add release docs.
1 parent abd48e2 commit 7a634ec

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/Release.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Release
2+
3+
GitHub Action is used to build the release files and publish them on PyPi.
4+
This is automatically triggered when a new tag is created.
5+
6+
## Pre-release steps
7+
8+
* Create a new branch with a name that starts with `release-`.
9+
Ex: `release-2.1.0`
10+
* Update the version inside setup.py
11+
* Update CHANGELOG.md with the latest version and release date.
12+
* Create a pull request and make sure all checks pass.
13+
The wheels are generated as part of the PR checks,
14+
but they are not yet published to PyPI.
15+
16+
17+
## Release steps
18+
19+
* Use [GitHub Release](https://github.com/ibm-messaging/mq-mqi-python/releases/new) to create a new release together with a new tag.
20+
* You don't have to create a GitHub Release, the important part is to
21+
create a new tag.
22+
* The tag value is the version. Without any prefix.
23+
* Once a tag is pushed to the repo, GitHub Action will re-run all the jobs
24+
and will publish to PyPI.
25+
26+
27+
## Post-release steps
28+
29+
* Update the version inside setup.py to the next development version.
30+
Increment the micro version and add a .dev0 suffix.
31+
* Merge the pull request

0 commit comments

Comments
 (0)