Update README.md with how to make release

equinor · Dec 13, 2023 · f20c3b1 · f20c3b1
1 parent cf2c872
commit f20c3b1
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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.