Release v2.5.1 - Changelog

SINTEF · Aug 30, 2023 · 1e361d5 · 1e361d5
1 parent cd79149
commit 1e361d5
Show file tree

Hide file tree

Showing 16 changed files with 36 additions and 22 deletions.
diff --git a/.github/workflows/cd_release.yml b/.github/workflows/cd_release.yml
@@ -172,7 +172,7 @@ jobs:
         if [ -n "${{ inputs.build_libs }}" ]; then
           pip install ${{ inputs.build_libs }}
         fi
-        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.0
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.1
 
     - name: Parse changelog configuration
       run: |

diff --git a/.github/workflows/ci_cd_updated_default_branch.yml b/.github/workflows/ci_cd_updated_default_branch.yml
@@ -223,7 +223,7 @@ jobs:
         python -m pip install --upgrade pip
         pip install -U setuptools wheel
         pip install ${EDITABLE}.${{ inputs.doc_extras }}
-        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.0
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.1
 
     - name: Set up git user
       if: env.RELEASE_RUN == 'false'

diff --git a/.github/workflows/ci_check_pyproject_dependencies.yml b/.github/workflows/ci_check_pyproject_dependencies.yml
@@ -73,7 +73,7 @@ jobs:
         python -m pip install -U pip
         pip install -U setuptools wheel
         pip install .${{ inputs.install_extras }}
-        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.0
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.1
 
     - name: Set up git user
       run: |

diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml
@@ -379,7 +379,7 @@ jobs:
         python -m pip install -U pip
         pip install -U setuptools wheel
         pip install ${EDITABLE}.${{ inputs.install_extras }}
-        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.0
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.1
 
     - name: Update API Reference
       if: env.framework == 'mkdocs' && inputs.update_python_api_ref

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,18 +2,32 @@
 
 ## [Unreleased](https://github.com/SINTEF/ci-cd/tree/HEAD)
 
-[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.5.0...HEAD)
+[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.5.1...HEAD)
 
 **Fixed bugs:**
 
-- `pylint_options` not working as intended [\#169](https://github.com/SINTEF/ci-cd/issues/169)
+- Regression in `--full-docs-dir` input [\#174](https://github.com/SINTEF/ci-cd/issues/174)
+
+## [v2.5.1](https://github.com/SINTEF/ci-cd/tree/v2.5.1) (2023-08-30)
+
+[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.5.0...v2.5.1)
+
+**Fixed bugs:**
+
+- Too strict release tag name requirements [\#172](https://github.com/SINTEF/ci-cd/issues/172)
+
+**Merged pull requests:**
+
+- Fix --full-docs-dir regression [\#175](https://github.com/SINTEF/ci-cd/pull/175) ([CasperWA](https://github.com/CasperWA))
+- Remove requirement for release to start with 'v' [\#173](https://github.com/SINTEF/ci-cd/pull/173) ([CasperWA](https://github.com/CasperWA))
 
 ## [v2.5.0](https://github.com/SINTEF/ci-cd/tree/v2.5.0) (2023-08-29)
 
 [Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.4.0...v2.5.0)
 
 **Fixed bugs:**
 
+- `pylint_options` not working as intended [\#169](https://github.com/SINTEF/ci-cd/issues/169)
 - Pre-commit for documentation not working on windows [\#160](https://github.com/SINTEF/ci-cd/issues/160)
 
 **Merged pull requests:**

diff --git a/ci_cd/__init__.py b/ci_cd/__init__.py
@@ -1,4 +1,4 @@
 """CI/CD Tools. Tiny package to run invoke tasks as a standalone program."""
-__version__ = "2.5.0"
+__version__ = "2.5.1"
 __author__ = "Casper Welzel Andersen"
 __author_email__ = "casper.w.andersen@sintef.no"
diff --git a/docs/hooks/docs_api_reference.md b/docs/hooks/docs_api_reference.md
@@ -58,7 +58,7 @@ It is meant to be complete as is.
 ```yaml
 repos:
   - repo: https://github.com/SINTEF/ci-cd
-    rev: v2.5.0
+    rev: v2.5.1
     hooks:
     - id: docs-api-reference
       args:

diff --git a/docs/hooks/docs_landing_page.md b/docs/hooks/docs_landing_page.md
@@ -32,7 +32,7 @@ It is meant to be complete as is.
 ```yaml
 repos:
   - repo: https://github.com/SINTEF/ci-cd
-    rev: v2.5.0
+    rev: v2.5.1
     hooks:
     - id: docs-landing-page
       args:

diff --git a/docs/hooks/update_pyproject.md b/docs/hooks/update_pyproject.md
@@ -64,7 +64,7 @@ It is meant to be complete as is.
 ```yaml
 repos:
   - repo: https://github.com/SINTEF/ci-cd
-    rev: v2.5.0
+    rev: v2.5.1
     hooks:
     - id: update-pyproject
       args:

diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 # CI/CD tools
 
-**Current version to use:** `v2.5.0`
+**Current version to use:** `v2.5.1`
 
 Use tried and tested continuous integration (CI) and continuous deployment (CD) tools from this repository.
 

diff --git a/docs/workflows/cd_release.md b/docs/workflows/cd_release.md
@@ -29,7 +29,7 @@ See the [proper section](../hooks/docs_api_reference.md#using-it-together-with-c
 The content of repository files can be updated to use the new version where necessary.
 This is done through the `version_update_changes` (and `version_update_changes_separator`) inputs.
 
-To see an example of how to use the `version_update_changes` (and `version_update_changes_separator`) see for example the [workflow used by the SINTEF/ci-cd repository](https://github.com/SINTEF/ci-cd/blob/v2.5.0/.github/workflows/_local_cd_release.yml) calling the _CD Release_ workflow.
+To see an example of how to use the `version_update_changes` (and `version_update_changes_separator`) see for example the [workflow used by the SINTEF/ci-cd repository](https://github.com/SINTEF/ci-cd/blob/v2.5.1/.github/workflows/_local_cd_release.yml) calling the _CD Release_ workflow.
 
 Some notes to consider and respect when using `version_update_changes` are:
 
@@ -133,7 +133,7 @@ on:
 jobs:
   publish:
     name: Publish package and documentation
-    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.5.1
     if: github.repository == 'SINTEF/my-python-package' && startsWith(github.ref, 'refs/tags/v')
     with:
       git_username: "Casper Welzel Andersen"

diff --git a/docs/workflows/ci_automerge_prs.md b/docs/workflows/ci_automerge_prs.md
@@ -55,7 +55,7 @@ on:
 jobs:
   update-dependency-branch:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.1
     if: github.repository_owner == 'SINTEF' && ( ( startsWith(github.event.pull_request.head.ref, 'dependabot/') && github.actor == 'dependabot[bot]' ) || ( github.event.pull_request.head.ref == 'ci/update-pyproject' && github.actor == 'CasperWA' ) )
     secrets:
       PAT: ${{ secrets.RELEASE_PAT }}
@@ -76,7 +76,7 @@ on:
 jobs:
   update-dependency-branch:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.1
     if: github.repository_owner == 'SINTEF' && ( ( startsWith(github.event.pull_request.head.ref, 'dependabot/') && github.actor == 'dependabot[bot]' ) || ( github.event.pull_request.head.ref == 'ci/update-pyproject' && github.actor == 'CasperWA' ) )
     with:
       perform_changes: true
@@ -100,7 +100,7 @@ on:
 jobs:
   update-dependency-branch:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.1
     if: github.repository_owner == 'SINTEF' && ( ( startsWith(github.event.pull_request.head.ref, 'dependabot/') && github.actor == 'dependabot[bot]' ) || ( github.event.pull_request.head.ref == 'ci/update-pyproject' && github.actor == 'CasperWA' ) )
     with:
       perform_changes: true

diff --git a/docs/workflows/ci_cd_updated_default_branch.md b/docs/workflows/ci_cd_updated_default_branch.md
@@ -102,7 +102,7 @@ on:
 jobs:
   updates-to-stable:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.5.1
     if: github.repository_owner == 'SINTEF'
     with:
       git_username: "Casper Welzel Andersen"

diff --git a/docs/workflows/ci_check_pyproject_dependencies.md b/docs/workflows/ci_check_pyproject_dependencies.md
@@ -33,7 +33,7 @@ Here is an example of different lines given as value for the `ignore` option tha
 # ...
 jobs:
   check-dependencies:
-    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.1
     with:
       # ...
       # For Sphinx, ignore all updates for/from version 4.5.0 and up / keep the minimum version for Sphinx at 4.5.0.
@@ -88,7 +88,7 @@ on:
 jobs:
   check-dependencies:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.1
     if: github.repository_owner == 'SINTEF'
     with:
       git_username: "Casper Welzel Andersen"

diff --git a/docs/workflows/ci_tests.md b/docs/workflows/ci_tests.md
@@ -163,7 +163,7 @@ on:
 jobs:
   tests:
     name: Run basic tests
-    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.5.1
     with:
       python_version_pylint_safety: "3.8"
       python_version_docs: "3.7"
@@ -191,7 +191,7 @@ on:
 jobs:
   tests:
     name: Run basic tests
-    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.5.1
     with:
       python_version_pylint_safety: "3.8"
       python_version_docs: "3.7"

diff --git a/docs/workflows/ci_update_dependencies.md b/docs/workflows/ci_update_dependencies.md
@@ -65,7 +65,7 @@ on:
 jobs:
   check-dependencies:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.5.0
+    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.5.1
     if: github.repository_owner == 'SINTEF'
     with:
       git_username: "Casper Welzel Andersen"