Skip to content

Commit 35e63d3

Browse files
Merge pull request #505 from pystorm/update/add-release-instructions
Add release instructions
2 parents 884ceb3 + 35e7840 commit 35e63d3

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Integrates with Apache Storm.
1919
topologies
2020
api
2121
develop
22+
releases
2223
faq
2324

2425
.. image:: images/quickstart.gif

doc/source/releases.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Cutting a new release
2+
3+
1. Update the version number in `version.py` using semver versioning rules.
4+
2. Tag your commit with the new version number. ie `git tag -a v0.1.0.dev0 -m "v0.1.0.dev0"` or `git tag -a v0.1.0 -m "v0.1.0" <commit hash>`
5+
3. Push the tag to GitHub. `git push origin v0.1.0`
6+
4. Install twine and install build. `pip install twine` and `pip install build`
7+
5. Build the package. `python -m build`
8+
6. Upload the package to test.pypi.org. `twine upload --repository testpypi dist/*` and verify you can install the test package.
9+
7. Upload the package to pypi.org. `twine upload dist/*` and verify you can install the package.
10+
8. Create a new release on GitHub.

0 commit comments

Comments
 (0)