From 5e96924f8178a2a9bb9d633450d38dc283177afa Mon Sep 17 00:00:00 2001 From: Tommy <10076072+tommyod@users.noreply.github.com> Date: Wed, 27 Dec 2023 12:57:46 +0100 Subject: [PATCH] Update README.md with how to make release (#197) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 1bcd4f27..84132af1 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,9 @@ apt install pandoc # Pandoc is required to build the documentation. pip install .[doc] sphinx-build -c docs/source/ -b html docs/source/ docs/build/html/ ``` + +## Releasing a new version + +- Create a tag, e.g. `git tag -a v1.0.0 -m "A short note" cf2c87270d3` locally on the commit. +- Push the tag, e.g. `git push upstream v1.0.0`. +- Create a release on the GitHub GUI.