Skip to content

Commit

Permalink
Cleanup releasing instructions. Closes #616.
Browse files Browse the repository at this point in the history
  • Loading branch information
ionelmc committed Mar 19, 2024
1 parent 93b5047 commit 9f5cd81
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions docs/releasing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ Releasing

The process for releasing should follow these steps:

#. Test that docs build and render properly by running ``tox -e docs,spell``.
#. Test that docs build and render properly by running ``tox -e docs``.

If there are bogus spelling issues add the words in ``spelling_wordlist.txt``.
#. Update ``CHANGELOG.rst`` and ``AUTHORS.rst`` to be up to date.
#. Bump the version by running ``bumpversion [ major | minor | patch ]``. This will automatically add a tag.

Alternatively, you can manually edit the files and run ``git tag v1.2.3`` yourself.
#. Push changes and tags with::

git push
git push --tags
#. Wait for `AppVeyor <https://ci.appveyor.com/project/pytestbot/pytest-cov>`_
and `GitHub Actions <https://github.com/pytest-dev/pytest-cov/actions>`_ to give the green builds.
#. Wait `GitHub Actions <https://github.com/pytest-dev/pytest-cov/actions>`_ to give the green builds.
#. Check that the docs on `ReadTheDocs <https://readthedocs.org/projects/pytest-cov>`_ are built.
#. Make sure you have a clean checkout, run ``git status`` to verify.
#. Manually clean temporary files (that are ignored and won't show up in ``git status``)::
Expand Down

0 comments on commit 9f5cd81

Please sign in to comment.