Release v2.8.2 - Changelog

SINTEF · Aug 22, 2024 · 3f2a092 · 3f2a092
1 parent 05e77fd
commit 3f2a092
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 28 deletions.
diff --git a/.github/workflows/cd_release.yml b/.github/workflows/cd_release.yml
@@ -213,7 +213,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.8.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.8.2
       env:
         PIP_INDEX_URL: ${{ inputs.pip_index_url }}
         PIP_EXTRA_INDEX_URL: ${{ inputs.pip_extra_index_urls }}

diff --git a/.github/workflows/ci_cd_updated_default_branch.yml b/.github/workflows/ci_cd_updated_default_branch.yml
@@ -252,7 +252,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.8.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.8.2
 
         INSTALLED_PACKAGES=$(pip freeze)
         if [ "${{ inputs.docs_framework }}" == "mkdocs" ]; then

diff --git a/.github/workflows/ci_check_pyproject_dependencies.yml b/.github/workflows/ci_check_pyproject_dependencies.yml
@@ -156,7 +156,7 @@ jobs:
         python -m pip install -U ${VERBOSE} pip
         pip install -U ${VERBOSE} setuptools wheel
         pip install ${VERBOSE} .${{ inputs.install_extras }}
-        pip install ${VERBOSE} git+https://github.com/SINTEF/ci-cd.git@v2.8.1
+        pip install ${VERBOSE} git+https://github.com/SINTEF/ci-cd.git@v2.8.2
       env:
         PIP_INDEX_URL: ${{ inputs.pip_index_url }}
         PIP_EXTRA_INDEX_URL: ${{ inputs.pip_extra_index_urls }}

diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml
@@ -446,7 +446,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.8.1
+        pip install git+https://github.com/SINTEF/ci-cd.git@v2.8.2
       env:
         PIP_INDEX_URL: ${{ inputs.pip_index_url_docs }}
         PIP_EXTRA_INDEX_URL: ${{ inputs.pip_extra_index_urls_docs }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,20 +2,35 @@
 
 ## [Unreleased](https://github.com/SINTEF/ci-cd/tree/HEAD)
 
-[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.8.1...HEAD)
+[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.8.2...HEAD)
 
-## Support custom PyPI indices
+## Support self-hosted runners
 
-All callable workflows now have support for setting the `PIP_INDEX_URL` and `PIP_EXTRA_INDEX_URL` environment variable whenever `pip install` is being invoked.
-Note, the `PIP_EXTRA_INDEX_URL` allows for multiple URLs to be provided, given they are space-delimited.
+The `runs-on` key can not be specified via the `runner` input, which is available for all callable workflows.
+This means one can use the callable workflows with self-hosted runners, for example.
 
-For more information on the specific workflow, see the documentation.
+It is worth noting that the workflows are built with Linux/Unix systems in mind, hence specifying `windows-latest` may lead to issues with certain workflows. This is also true if the self-hosted runner is not Linux/Unix-based.
 
 **Implemented enhancements:**
 
-- Support custom pip index URL\(s\) [\#276](https://github.com/SINTEF/ci-cd/issues/276)
+- Support self-hosted runners [\#279](https://github.com/SINTEF/ci-cd/issues/279)
 
-## [v2.8.1](https://github.com/SINTEF/ci-cd/tree/v2.8.1) (2024-08-21)
+## [v2.8.2](https://github.com/SINTEF/ci-cd/tree/v2.8.2) (2024-08-22)
+
+[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.8.1...v2.8.2)
+
+## Support self-hosted runners
+
+The `runs-on` key can not be specified via the `runner` input, which is available for all callable workflows.
+This means one can use the callable workflows with self-hosted runners, for example.
+
+It is worth noting that the workflows are built with Linux/Unix systems in mind, hence specifying `windows-latest` may lead to issues with certain workflows. This is also true if the self-hosted runner is not Linux/Unix-based.
+
+**Merged pull requests:**
+
+- Add `runner` input for all callable workflows [\#280](https://github.com/SINTEF/ci-cd/pull/280) ([CasperWA](https://github.com/CasperWA))
+
+## [v2.8.1](https://github.com/SINTEF/ci-cd/tree/v2.8.1) (2024-08-22)
 
 [Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.8.0...v2.8.1)
 
@@ -26,6 +41,10 @@ Note, the `PIP_EXTRA_INDEX_URL` allows for multiple URLs to be provided, given t
 
 For more information on the specific workflow, see the documentation.
 
+**Implemented enhancements:**
+
+- Support custom pip index URL\(s\) [\#276](https://github.com/SINTEF/ci-cd/issues/276)
+
 **Merged pull requests:**
 
 - Support adding pip index URLs [\#277](https://github.com/SINTEF/ci-cd/pull/277) ([CasperWA](https://github.com/CasperWA))

diff --git a/ci_cd/__init__.py b/ci_cd/__init__.py
@@ -4,7 +4,7 @@
 
 import logging
 
-__version__ = "2.8.1"
+__version__ = "2.8.2"
 __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.8.1
+    rev: v2.8.2
     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.8.1
+    rev: v2.8.2
     hooks:
     - id: docs-landing-page
       args:

diff --git a/docs/hooks/update_pyproject.md b/docs/hooks/update_pyproject.md
@@ -66,7 +66,7 @@ It is meant to be complete as is.
 ```yaml
 repos:
   - repo: https://github.com/SINTEF/ci-cd
-    rev: v2.8.1
+    rev: v2.8.2
     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.8.1`
+**Current version to use:** `v2.8.2`
 
 !!! warning "Important"
     The default for `publish_on_pypi` in the [_CD - Release_ workflow](./workflows/cd_release.md) has changed from `true` to `false` in version `2.8.0`.

diff --git a/docs/workflows/cd_release.md b/docs/workflows/cd_release.md
@@ -63,7 +63,7 @@ jobs:
   build:
     name: Build distribution & publish documentation
     if: github.repository == 'SINTEF/my-python-package' && startsWith(github.ref, 'refs/tags/v')
-    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.2
     with:
       # General
       git_username: "Casper Welzel Andersen"
@@ -120,7 +120,7 @@ jobs:
 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.8.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.8.2/.github/workflows/_local_cd_release.yml) calling the _CD Release_ workflow.
 
 Some notes to consider and respect when using `version_update_changes` are:
 
@@ -235,7 +235,7 @@ on:
 jobs:
   publish:
     name: Publish package and documentation
-    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.2
     if: github.repository == 'SINTEF/my-python-package' && startsWith(github.ref, 'refs/tags/v')
     with:
       # General

diff --git a/docs/workflows/ci_automerge_prs.md b/docs/workflows/ci_automerge_prs.md
@@ -56,7 +56,7 @@ on:
 jobs:
   update-dependency-branch:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.2
     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 }}
@@ -77,7 +77,7 @@ on:
 jobs:
   update-dependency-branch:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.2
     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
@@ -101,7 +101,7 @@ on:
 jobs:
   update-dependency-branch:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.2
     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
@@ -106,7 +106,7 @@ on:
 jobs:
   updates-to-stable:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.8.2
     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
@@ -37,7 +37,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.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.8.2
     with:
       # ...
       # For Sphinx, ignore all updates for/from version 4.5.0 and up / keep the minimum version for Sphinx at 4.5.0.
@@ -99,7 +99,7 @@ on:
 jobs:
   check-dependencies:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.8.2
     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
@@ -177,7 +177,7 @@ on:
 jobs:
   tests:
     name: Run basic tests
-    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.2
     with:
       python_version_pylint_safety: "3.8"
       python_version_docs: "3.7"
@@ -205,7 +205,7 @@ on:
 jobs:
   tests:
     name: Run basic tests
-    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.2
     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
@@ -68,7 +68,7 @@ on:
 jobs:
   check-dependencies:
     name: Call external workflow
-    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.8.1
+    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.8.2
     if: github.repository_owner == 'SINTEF'
     with:
       git_username: "Casper Welzel Andersen"