Skip to content

Commit 6dc786c

Browse files
committed
Fix formatting to be reST.
1 parent 24e721e commit 6dc786c

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

doc/releases.rst

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
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.
1+
Creating a new Streamparse Release
2+
==================================
3+
4+
First, update the version number in ``version.py`` using `semantic versioning <https://semver.org>`_.
5+
6+
7+
Tag your commit with the new version number. For example:::
8+
9+
git tag -a v0.1.0 -m "v0.1.0"
10+
11+
Push the tag to GitHub::
12+
13+
git push origin v0.1.0
14+
15+
Install twine and install build.
16+
17+
pip install twine
18+
pip install build
19+
20+
Build the package.
21+
22+
python -m build
23+
24+
Upload the package to test.pypi.org and verify you can install it::
25+
26+
twine upload --repository testpypi dist/*
27+
28+
Upload the package to pypi.org and verify you can install it::
29+
30+
twine upload dist/*
31+
32+
Create a new release on GitHub.
33+
34+
.. _SEMVER: https://semver.org

0 commit comments

Comments
 (0)