Bump version + add release docs

i-VRESSE · Oct 22, 2024 · a926a40 · a926a40
1 parent 9b4214f
commit a926a40
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "bartender"
-release = "0.5.1"  # TODO have version only in one place pyproject.toml
+release = "0.5.2"  # TODO have version only in one place pyproject.toml
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/develop.md b/docs/develop.md
@@ -232,3 +232,14 @@ dirac-dms-filecatalog-cli
 # pilot logs
 cat ~diracpilot/localsite/output/*
 ```
+
+## Creating a new release
+
+To create a new release, you should follow these steps:
+
+1. In `pyproject.toml` and `docs/conf.py` update the version number.
+2. Create a new GitHub release
+
+- set tag and title to new version number with `v` prefix.
+- with same first line of description as previous release.
+- append generated release notes to the description.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bartender"
-version = "0.5.1"
+version = "0.5.2"
 description = "Job middleware for i-VRESSE"
 authors = [