From 886aef998c5d51bf160aed66e1ab9f6bdeeb5e34 Mon Sep 17 00:00:00 2001 From: Thomas Aglassinger Date: Thu, 6 Jan 2022 19:59:34 +0100 Subject: [PATCH 1/2] #75 Improved badges. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b78c015..8256cb4 100644 --- a/README.md +++ b/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 From 385d5855c81677e3f0230ce5a63e7dc7a4a09818 Mon Sep 17 00:00:00 2001 From: Thomas Aglassinger Date: Thu, 6 Jan 2022 20:00:16 +0100 Subject: [PATCH 2/2] #75 Added release cheatsheet. --- docs/changes.rst | 2 +- docs/contributing.rst | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/changes.rst b/docs/changes.rst index c08317d..6288147 100644 --- a/docs/changes.rst +++ b/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 * Changed build process to `poetry `_ to change several messy configuration files into a single even more messy diff --git a/docs/contributing.rst b/docs/contributing.rst index 220f48a..147c7f2 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -74,3 +74,35 @@ the code without performing a commit, run: In particular, this applies `black `_, `flake8 `_ and `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