Skip to content

Commit 78acb0e

Browse files
committed
Fix formatting to be reST.
1 parent 24e721e commit 78acb0e

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

doc/releases.rst

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,33 @@
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+
Tag your commit with the new version number. For example::
7+
8+
git tag -a v0.1.0 -m "v0.1.0"
9+
10+
Push the tag to GitHub::
11+
12+
git push origin v0.1.0
13+
14+
Install twine and install build::
15+
16+
pip install twine
17+
pip install build
18+
19+
Build the package::
20+
21+
python -m build
22+
23+
Upload the package to test.pypi.org::
24+
25+
twine upload --repository testpypi dist/*
26+
27+
*Verify you can install it.* Then, upload it to pypi.org::
28+
29+
twine upload dist/*
30+
31+
*Again, verify it installs correctly.* Then, finally, create a new release on GitHub.
32+
33+
.. _SEMVER: https://semver.org

0 commit comments

Comments
 (0)