Repository: EMMC-ASBL/tripper (language: python)

Issue:
Add instructions of how to release a new version
It seems that the CI/CD takes care of bumping up the version number in the `tripper/__init__.py`, but that is not evident.

It would be great with a short instruction of how to release new versions for developers. It seems to be very straight forward :-)



Discussion / hints:

Fix patch:
diff --git a/.github/workflows/cd_release.yml b/.github/workflows/cd_release.yml
index 0e92ffb5..226c5dfd 100644
--- a/.github/workflows/cd_release.yml
+++ b/.github/workflows/cd_release.yml
@@ -6,9 +6,9 @@ on:
     - published
 
 jobs:
-  publish-package-and-docs:
+  build:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.0
+    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.2
     if: github.repository == 'EMMC-ASBL/tripper' && startsWith(github.ref, 'refs/tags/v')
     with:
       # General
@@ -23,6 +23,7 @@ jobs:
       python_version_build: "3.9"
       build_libs: "flit"
       build_cmd: "flit build"
+      build_dir: "dist"
       publish_on_pypi: false
       upload_distribution: true
 
@@ -33,7 +34,6 @@ jobs:
       changelog_exclude_labels: "skip_changelog,duplicate,question,invalid,wontfix"
       docs_framework: mkdocs
     secrets:
-      #PyPI_token: ${{ secrets.PYPI_TOKEN }}
       PAT: ${{ secrets.RELEASE_PAT }}
 
   publish:
@@ -41,7 +41,9 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
 
-    #environment: release
+    environment:
+      name: release
+      url: https://pypi.org/project/tripper/
     permissions:
       id-token: write
 
@@ -49,6 +51,7 @@ jobs:
       - name: Download built distritbution
         uses: actions/download-artifact@v4
         with:
+          name: dist
           path: dist
 
       - name: Publish on PyPI
diff --git a/.github/workflows/ci_automerge_dependency_prs.yml b/.github/workflows/ci_automerge_dependency_prs.yml
index 86eab1c5..90dbbc0e 100644
--- a/.github/workflows/ci_automerge_dependency_prs.yml
+++ b/.github/workflows/ci_automerge_dependency_prs.yml
@@ -7,7 +7,7 @@ on:
 jobs:
   update-dependencies-branch:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL' && ( ( startsWith(github.event.pull_request.head.ref, 'dependabot/') && github.actor == 'dependabot[bot]' ) || ( github.event.pull_request.head.ref == 'ci/update-pyproject' && github.actor == 'TEAM4-0' ) )
     secrets:
       PAT: ${{ secrets.RELEASE_PAT }}
diff --git a/.github/workflows/ci_cd_updated_main.yml b/.github/workflows/ci_cd_updated_main.yml
index d30ed5ec..381681de 100644
--- a/.github/workflows/ci_cd_updated_main.yml
+++ b/.github/workflows/ci_cd_updated_main.yml
@@ -7,7 +7,7 @@ on:
 jobs:
   update-deps-branch-and-docs:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.8.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL'
     with:
       # General
diff --git a/.github/workflows/ci_check_dependencies.yml b/.github/workflows/ci_check_dependencies.yml
index 6e5fc351..59a5a03a 100644
--- a/.github/workflows/ci_check_dependencies.yml
+++ b/.github/workflows/ci_check_dependencies.yml
@@ -9,7 +9,7 @@ on:
 jobs:
   check-dependencies:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.8.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL'
     with:
       git_username: "TEAM 4.0[bot]"
diff --git a/.github/workflows/ci_update_dependencies.yml b/.github/workflows/ci_update_dependencies.yml
index 5598585b..73f3f137 100644
--- a/.github/workflows/ci_update_dependencies.yml
+++ b/.github/workflows/ci_update_dependencies.yml
@@ -9,7 +9,7 @@ on:
 jobs:
   create-collected-pr:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.8.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL'
     with:
       git_username: "TEAM 4.0[bot]"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 6fbe6627..336d9ea3 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -44,7 +44,7 @@ repos:
     rev: 24.8.0
     hooks:
     - id: black
-      line-length: 79
+      args: [--line-length=79]
 
   - repo: https://github.com/PyCQA/bandit
     rev: 1.7.9
@@ -63,7 +63,7 @@ repos:
         - "pydantic"
 
   - repo: https://github.com/SINTEF/ci-cd
-    rev: v2.8.0
+    rev: v2.8.2
     hooks:
     - id: docs-api-reference
       args:
diff --git a/docs/developers.md b/docs/developers.md
new file mode 100644
index 00000000..b1d5b218
--- /dev/null
+++ b/docs/developers.md
@@ -0,0 +1,17 @@
+# For developers
+
+## New release
+
+To create a new release, it is good to have a release summary.
+
+To add this, create a milestone that matches the new version and tag, e.g., `v1.0.8`.
+
+Then create a new issue, adding it to the milestone and add the `release-summary` label.
+
+For the issue description, write the actual release summary.
+This will be included as part of the changelog as well as the release notes on GitHub.
+
+Then, go to [create a new GitHub releases](https://github.com/EMMC-ASBL/tripper/releases/new) and select the tag that matches the milestone (creating a new one).
+Add again the tag as the release title (optionally write something else that defines this release as a title).
+
+Finally, press the "Publish release" button and ensure the release workflow succeeds (check [the release workflow](https://github.com/EMMC-ASBL/tripper/actions/workflows/cd_release.yml)).
diff --git a/mkdocs.yml b/mkdocs.yml
index 93fd0041..cf56fbff 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -83,6 +83,7 @@ nav:
   - Backend discovery: backend_discovery.md
   - ... | api_reference/**
   - Known issues: known-issues.md
+  - For developers: developers.md
   - Changelog: CHANGELOG.md
   - License: LICENSE.md
 


Test patch:
diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml
index 513641f1..b0018fdf 100644
--- a/.github/workflows/ci_tests.yml
+++ b/.github/workflows/ci_tests.yml
@@ -10,7 +10,7 @@ on:
 jobs:
   basic-tests:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.2
     with:
       ## General settings:
       install_extras: "[dev]"