Release v2.4.0 - Changelog

SINTEF · May 23, 2023 · 33f5f96 · 33f5f96
1 parent ebe8eef
commit 33f5f96
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 20 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.3.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.4.0
 
     - 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
@@ -217,7 +217,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.3.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.4.0
 
     - 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.3.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.4.0
 
     - name: Set up git user
       run: |

diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml
@@ -361,7 +361,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.3.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.4.0
 
     - name: Update API Reference
       if: env.framework == 'mkdocs' && inputs.update_python_api_ref

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,42 @@
 # Changelog
 
+## [Unreleased](https://github.com/SINTEF/ci-cd/tree/HEAD)
+
+[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.4.0...HEAD)
+
+**Fixed bugs:**
+
+- Issues with the ignore-functionality of `ci-cd update-deps` [\#130](https://github.com/SINTEF/ci-cd/issues/130)
+
+## [v2.4.0](https://github.com/SINTEF/ci-cd/tree/v2.4.0) (2023-05-23)
+
+[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.3.1...v2.4.0)
+
+**Implemented enhancements:**
+
+- Automatically merge CI workflow to update deps [\#101](https://github.com/SINTEF/ci-cd/issues/101)
+- Support Sphinx for documentation building [\#90](https://github.com/SINTEF/ci-cd/issues/90)
+- Add hook for using the `update-deps` task [\#24](https://github.com/SINTEF/ci-cd/issues/24)
+
+**Fixed bugs:**
+
+- Flawed logic [\#152](https://github.com/SINTEF/ci-cd/issues/152)
+- Error in workflow [\#150](https://github.com/SINTEF/ci-cd/issues/150)
+
+**Closed issues:**
+
+- Error in .github/workflows/ci\_automerge\_prs.yml which makes automerging fail in outside repos [\#139](https://github.com/SINTEF/ci-cd/issues/139)
+
+**Merged pull requests:**
+
+- Fix logic for checking documentation framework [\#153](https://github.com/SINTEF/ci-cd/pull/153) ([CasperWA](https://github.com/CasperWA))
+- Fix typos in workflows [\#151](https://github.com/SINTEF/ci-cd/pull/151) ([CasperWA](https://github.com/CasperWA))
+- \[Auto-generated\] Update dependencies [\#143](https://github.com/SINTEF/ci-cd/pull/143) ([TEAM4-0](https://github.com/TEAM4-0))
+- Fix ignore functionality \(especially for 'version' rules\) [\#140](https://github.com/SINTEF/ci-cd/pull/140) ([CasperWA](https://github.com/CasperWA))
+- Add `update-pyproject` pre-commit hook [\#128](https://github.com/SINTEF/ci-cd/pull/128) ([CasperWA](https://github.com/CasperWA))
+- Activate auto-merge for pyproject.toml update PRs [\#114](https://github.com/SINTEF/ci-cd/pull/114) ([CasperWA](https://github.com/CasperWA))
+- Support Sphinx [\#92](https://github.com/SINTEF/ci-cd/pull/92) ([CasperWA](https://github.com/CasperWA))
+
 ## [v2.3.1](https://github.com/SINTEF/ci-cd/tree/v2.3.1) (2023-04-13)
 
 [Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.3.0...v2.3.1)

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.3.1"
+__version__ = "2.4.0"
 __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.3.1
+    rev: v2.4.0
     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.3.1
+    rev: v2.4.0
     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.2.1
+    rev: v2.4.0
     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.3.1`
+**Current version to use:** `v2.4.0`
 
 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.3.1/.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.4.0/.github/workflows/_local_cd_release.yml) calling the _CD Release_ workflow.
 
 Some notes to consider and respect when using `version_update_changes` are:
 
@@ -131,7 +131,7 @@ on:
 jobs:
   publish:
     name: Publish package and documentation
-    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.3.1
+    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.4.0
     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.3.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.4.0
     if: github.repository_owner == 'SINTEF'
     with:
       git_username: "Casper Welzel Andersen"