Skip to content

Commit e7b0f6d

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

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

doc/releases.rst

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

0 commit comments

Comments
 (0)