Skip to content

Commit

Permalink
Fix formatting to be reST.
Browse files Browse the repository at this point in the history
  • Loading branch information
kbourgoin committed Aug 6, 2024
1 parent 24e721e commit 78acb0e
Showing 1 changed file with 33 additions and 10 deletions.
43 changes: 33 additions & 10 deletions doc/releases.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
# Cutting a new release

1. Update the version number in `version.py` using semver versioning rules.
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>`
3. Push the tag to GitHub. `git push origin v0.1.0`
4. Install twine and install build. `pip install twine` and `pip install build`
5. Build the package. `python -m build`
6. Upload the package to test.pypi.org. `twine upload --repository testpypi dist/*` and verify you can install the test package.
7. Upload the package to pypi.org. `twine upload dist/*` and verify you can install the package.
8. Create a new release on GitHub.
Creating a new Streamparse Release
==================================

First, update the version number in ``version.py`` using `semantic versioning <https://semver.org>`_.

Tag your commit with the new version number. For example::

git tag -a v0.1.0 -m "v0.1.0"

Push the tag to GitHub::

git push origin v0.1.0

Install twine and install build::

pip install twine
pip install build

Build the package::

python -m build

Upload the package to test.pypi.org::

twine upload --repository testpypi dist/*

*Verify you can install it.* Then, upload it to pypi.org::

twine upload dist/*

*Again, verify it installs correctly.* Then, finally, create a new release on GitHub.

.. _SEMVER: https://semver.org

0 comments on commit 78acb0e

Please sign in to comment.