Drop coverage, add release instructions (#28)

* removing coverage, drop deps and makefile targets

* more coverage removal, add new release instructions to contributing

* newsfragments

Author: pacrob

.gitignore

@@ -35,15 +35,11 @@ var/
 pip-log.txt
 pip-delete-this-directory.txt
 
-# Unit test / coverage reports
+# Unit test reports
 htmlcov/
 .tox/
-.coverage
-.coverage.*
 .cache
 nosetests.xml
-coverage.xml
-*,cover
 .hypothesis/
 
 # Translations

CONTRIBUTING.rst

@@ -118,9 +118,6 @@ The project provides several ``make`` targets to help with development:
   run linting, type checking, and tests. This is the recommended command to run
   before submitting a pull request.
 
-* ``make coverage`` - Run tests with coverage reporting and open the HTML report
-  in your browser.
-
 For a full list of available commands, run ``make help``.
 
 7. Commit your changes and push your branch to GitHub::
@@ -151,16 +148,76 @@ To run a subset of tests::
 
 $ pytest tests/test_multibase.py
 
-
-Deploying
+Releasing
 ---------
 
-A reminder for the maintainers on how to deploy.
-Make sure all your changes are committed (including an entry in HISTORY.rst).
-Then run::
+Releases are typically done from the ``master`` branch, except when releasing a beta (in
+which case the beta is released from ``master``, and the previous stable branch is
+released from said branch).
+
+Final test before each release
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Before releasing a new version, build and test the package that will be released:
+
+.. code:: sh
+
+    git checkout master && git pull
+    make package-test
+
+This will build the package and install it in a temporary virtual environment. Follow
+the instructions to activate the venv and test whatever you think is important.
+
+You can also preview the release notes:
+
+.. code:: sh
+
+    towncrier --draft
+
+Build the release notes
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Before bumping the version number, build the release notes. You must include the part of
+the version to bump (see below), which changes how the version number will show in the
+release notes.
+
+.. code:: sh
+
+    make notes bump=$$VERSION_PART_TO_BUMP$$
+
+If there are any errors, be sure to re-run make notes until it works.
+
+Push the release to github & pypi
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+After confirming that the release package looks okay, release a new version:
+
+.. code:: sh
+
+    make release bump=$$VERSION_PART_TO_BUMP$$
+
+This command will:
+
+- Bump the version number as specified wherever it appears in the repo.
+- Create a git commit and tag for the new version.
+- Build the package.
+- Push the commit and tag to github.
+- Push the new package files to pypi.
+
+Which version part to bump
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``$$VERSION_PART_TO_BUMP$$`` must be one of: ``major``, ``minor``, ``patch``, ``stage``,
+or ``devnum``.
+
+The version format for this repo is ``{major}.{minor}.{patch}`` for stable, and
+``{major}.{minor}.{patch}-{stage}.{devnum}`` for unstable (``stage`` can be alpha or
+beta).
+
+If you are in a beta version, ``make release bump=stage`` will switch to a stable.
 
-$ bump-my-version bump patch # possible: major / minor / patch
-$ git push
-$ git push --tags
+To issue an unstable version when the current version is stable, specify the new version
+explicitly, like ``make release bump="--new-version 4.0.0-alpha.1"``
 
-GitHub Actions will then deploy to PyPI if tests pass.
+You can see what the result of bumping any particular version part would be with
+``bump-my-version show-bump``

Makefile

@@ -22,7 +22,6 @@ help:
 	@echo "lint - run pre-commit hooks on all files"
 	@echo "typecheck - run mypy type checking"
 	@echo "test - run tests quickly with the default Python"
-	@echo "coverage - run tests with coverage report"
 	@echo "docs-ci - generate docs for CI"
 	@echo "docs - generate docs and open in browser"
 	@echo "servedocs - serve docs with live reload"
@@ -48,7 +47,6 @@ clean-test:
 	rm -fr .tox/
 	rm -fr .mypy_cache
 	rm -fr .ruff_cache
-	rm -f .coverage
 	rm -fr htmlcov/
 
 setup:
@@ -66,12 +64,6 @@ typecheck:
 test:
 	python -m pytest tests
 
-coverage:
-	coverage run --source multibase -m pytest tests
-	coverage report -m
-	coverage html
-	$(BROWSER) htmlcov/index.html
-
 docs-ci:
 	rm -f docs/multibase.rst
 	rm -f docs/modules.rst

README.rst

@@ -9,9 +9,6 @@ py-multibase
 .. image:: https://github.com/multiformats/py-multibase/actions/workflows/tox.yml/badge.svg
         :target: https://github.com/multiformats/py-multibase/actions
 
-.. image:: https://codecov.io/gh/multiformats/py-multibase/branch/master/graph/badge.svg
-        :target: https://codecov.io/gh/multiformats/py-multibase
-
 .. image:: https://readthedocs.org/projects/py-multibase/badge/?version=stable
         :target: https://py-multibase.readthedocs.io/en/stable/?badge=stable
         :alt: Documentation Status

codecov.yaml

@@ -0,0 +1 @@
+Added release documentation to contributing docs.

newsfragments/23.docs.rst

@@ -0,0 +1 @@
+Dropped ``coverage`` and ``codecov`` references, no longer using it.

newsfragments/23.internal.rst

@@ -38,12 +38,9 @@ dev = [
     "Sphinx>=5.0.0",
     "build>=0.9.0",
     "bump-my-version>=1.2.0",
-    "codecov",
-    "coverage>=6.5.0",
     "mypy",
     "pre-commit",
     "pytest",
-    "pytest-cov",
     "pytest-runner",
     "ruff",
     "towncrier>=24,<25",
@@ -65,21 +62,6 @@ include = ["multibase*"]
 testpaths = ["tests"]
 python_classes = "*TestCase"
 
-[tool.coverage.run]
-source = ["multibase"]
-
-[tool.coverage.report]
-exclude_lines = [
-    "pragma: no cover",
-    "def __repr__",
-    "if self.debug:",
-    "if settings.DEBUG",
-    "raise AssertionError",
-    "raise NotImplementedError",
-    "if 0:",
-    "if __name__ == .__main__.:",
-]
-
 [tool.towncrier]
 # Read https://github.com/multiformats/py-multibase/blob/master/newsfragments/README.md for instructions
 directory = "newsfragments"