Merge pull request #87 from roskakori/75-change-build-to-poetry

#75 Added release cheatsheet.

README.md

@@ -1,6 +1,8 @@
-![Python Versions](https://img.shields.io/pypi/pyversions/pygount.svg)
-![Build Status](https://github.com/roskakori/pygount/actions/workflows/build.yml/badge.svg)
+[![PyPI](https://img.shields.io/pypi/v/pygount)](https://pypi.org/project/pygount/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/pygount.svg)](https://www.python.org/downloads/)
+[![Build Status](https://github.com/roskakori/pygount/actions/workflows/build.yml/badge.svg)](https://github.com/roskakori/pygount/actions/workflows/build.yml)
 [![Test Coverage](https://img.shields.io/coveralls/github/roskakori/pygount)](https://coveralls.io/r/roskakori/pygount?branch=master)
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![License](https://img.shields.io/github/license/roskakori/pygount)](https://opensource.org/licenses/BSD-3-Clause)
 
 # pygount

docs/changes.rst

@@ -5,7 +5,7 @@ Changes
 
 This chapter describes the changes coming with each new version of pygount.
 
-Version 1.3.0, 2022-xx-xx
+Version 1.3.0, 2022-01-06
 
 * Fixed computation of "lines per second", which was a copy and paste of
   "files per second".

docs/contributing.rst

@@ -74,3 +74,35 @@ the code without performing a commit, run:
 In particular, this applies `black <https://black.readthedocs.io/en/stable/>`_,
 `flake8 <https://flake8.pycqa.org/>`_ and
 `isort <https://pypi.org/project/isort/>`_.
+
+Release cheatsheet
+------------------
+
+This section only relevant for developers with access to the PyPI project.
+
+To add a new release, first update the :file:`pyproject.toml`:
+
+.. code-block:: toml
+
+    [tool.poetry]
+    version = "1.x.x"
+
+Next build the project and run the tests to ensure everything works:
+
+.. code-block:: sh
+
+    $ poetry build
+    $ poetry run pytest
+
+Then create a tag in the repository:
+
+.. code-block:: sh
+
+    $ git tag -a -m "Tagged version 1.x.x." v1.x.x
+    $ git push --tags
+
+And finally publish the new version on PyPI:
+
+.. code-block:: sh
+
+    $ poetry publish