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 e7b0f6d
Showing 1 changed file with 31 additions and 9 deletions.
40 changes: 31 additions & 9 deletions doc/releases.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,32 @@
# 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.
Creating a new Streamparse Release
==================================

1. Update the version number in ``version.py`` using `semantic versioning <https://semver.org>`.
2. Tag your commit with the new version number. For example:::

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

3. Push the tag to GitHub::

git push origin v0.1.0

4. Install twine and install build.

pip install twine
pip install build

5. Build the package.

python -m build

6. Upload the package to test.pypi.org and verify you can install it::

twine upload --repository testpypi dist/*

7. Upload the package to pypi.org and verify you can install it::

twine upload dist/*

8. Create a new release on GitHub.

.. _SEMVER: https://semver.org

0 comments on commit e7b0f6d

Please sign in to comment.