Skip to content

Commit

Permalink
Merge pull request #82 from adleris/patch-1
Browse files Browse the repository at this point in the history
Fix formatting issues in README
  • Loading branch information
noahp authored Oct 18, 2023
2 parents 61d9462 + 908a836 commit 709587f
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,30 +87,35 @@ Publishing Release

1. Update the version in ``puncover/__version__.py``.
2. Commit the version update:

.. code-block:: bash
git add . && git commit -m "Bump version to x.y.z"
git add . && git commit -m "Bump version to x.y.z"
3. Create an annotated tag:

.. code-block:: bash
git tag -a {-m=,}x.y.z
git tag -a {-m=,}x.y.z
4. Push the commit and tag:

.. code-block:: bash
git push && git push --tags
git push && git push --tags
5. Either wait for the GitHub Action to complete and download the release
artifact for uploading: https://github.com/HBehrens/puncover/actions OR Build
the package locally: ``python setup.py sdist bdist_wheel``
6. Upload the package to PyPI:

.. code-block:: bash
twine upload dist/*
twine upload dist/*
7. Create GitHub releases:

- ``gh release create --generate-notes x.y.z``
- attach the artifacts to the release too: ``gh release upload x.y.z dist/*``

Expand Down

0 comments on commit 709587f

Please sign in to comment.