From 187ea235ee7e2acbcb5f24141a6f1be9173121b4 Mon Sep 17 00:00:00 2001 From: "TEAM 4.0[bot]" Date: Wed, 4 Oct 2023 08:06:21 +0000 Subject: [PATCH] Release v2.5.2 - Changelog --- .github/workflows/cd_release.yml | 2 +- .../workflows/ci_cd_updated_default_branch.yml | 2 +- .../ci_check_pyproject_dependencies.yml | 2 +- .github/workflows/ci_tests.yml | 2 +- CHANGELOG.md | 16 ++++++++++++---- ci_cd/__init__.py | 2 +- docs/hooks/docs_api_reference.md | 2 +- docs/hooks/docs_landing_page.md | 2 +- docs/hooks/update_pyproject.md | 2 +- docs/index.md | 2 +- docs/workflows/cd_release.md | 4 ++-- docs/workflows/ci_automerge_prs.md | 6 +++--- docs/workflows/ci_cd_updated_default_branch.md | 2 +- .../workflows/ci_check_pyproject_dependencies.md | 4 ++-- docs/workflows/ci_tests.md | 4 ++-- docs/workflows/ci_update_dependencies.md | 2 +- 16 files changed, 32 insertions(+), 24 deletions(-) diff --git a/.github/workflows/cd_release.yml b/.github/workflows/cd_release.yml index bd37cd31..8c15a882 100644 --- a/.github/workflows/cd_release.yml +++ b/.github/workflows/cd_release.yml @@ -179,7 +179,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.1 + pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.2 - 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 index d4aa793d..ebb84541 100644 --- 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.1 + pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.2 - 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 index 2eaaeedc..bd23f1e8 100644 --- 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.1 + pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.2 - name: Set up git user run: | diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml index 5410feec..05d972e8 100644 --- 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.1 + pip install git+https://github.com/SINTEF/ci-cd.git@v2.5.2 - name: Update API Reference if: env.framework == 'mkdocs' && inputs.update_python_api_ref diff --git a/CHANGELOG.md b/CHANGELOG.md index a6951e5a..64333baf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,19 @@ # Changelog -## [Unreleased](https://github.com/SINTEF/ci-cd/tree/HEAD) +## [v2.5.2](https://github.com/SINTEF/ci-cd/tree/v2.5.2) (2023-10-04) -[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.5.1...HEAD) +[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.5.1...v2.5.2) -**Fixed bugs:** +**Implemented enhancements:** -- Regression in `--full-docs-dir` input [\#174](https://github.com/SINTEF/ci-cd/issues/174) +- Toggle `latest` alias MkDocs release [\#187](https://github.com/SINTEF/ci-cd/issues/187) + +**Merged pull requests:** + +- \[Auto-generated\] Update dependencies [\#189](https://github.com/SINTEF/ci-cd/pull/189) ([TEAM4-0](https://github.com/TEAM4-0)) +- Add `mkdocs_update_latest` bool input [\#188](https://github.com/SINTEF/ci-cd/pull/188) ([CasperWA](https://github.com/CasperWA)) +- \[Auto-generated\] Update dependencies [\#185](https://github.com/SINTEF/ci-cd/pull/185) ([TEAM4-0](https://github.com/TEAM4-0)) +- \[Auto-generated\] Update dependencies [\#177](https://github.com/SINTEF/ci-cd/pull/177) ([TEAM4-0](https://github.com/TEAM4-0)) ## [v2.5.1](https://github.com/SINTEF/ci-cd/tree/v2.5.1) (2023-08-30) @@ -14,6 +21,7 @@ **Fixed bugs:** +- Regression in `--full-docs-dir` input [\#174](https://github.com/SINTEF/ci-cd/issues/174) - Too strict release tag name requirements [\#172](https://github.com/SINTEF/ci-cd/issues/172) **Merged pull requests:** diff --git a/ci_cd/__init__.py b/ci_cd/__init__.py index cc5af3e1..29bbf03d 100644 --- 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.1" +__version__ = "2.5.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 index e3591ff7..056ca965 100644 --- 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.1 + rev: v2.5.2 hooks: - id: docs-api-reference args: diff --git a/docs/hooks/docs_landing_page.md b/docs/hooks/docs_landing_page.md index 49081147..f76faabc 100644 --- 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.1 + rev: v2.5.2 hooks: - id: docs-landing-page args: diff --git a/docs/hooks/update_pyproject.md b/docs/hooks/update_pyproject.md index eae441ef..01be3d22 100644 --- 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.1 + rev: v2.5.2 hooks: - id: update-pyproject args: diff --git a/docs/index.md b/docs/index.md index ef5feb58..64bcb37f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # CI/CD tools -**Current version to use:** `v2.5.1` +**Current version to use:** `v2.5.2` 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 index d54c2a66..5c2b1ede 100644 --- 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.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.5.2/.github/workflows/_local_cd_release.yml) calling the _CD Release_ workflow. Some notes to consider and respect when using `version_update_changes` are: @@ -139,7 +139,7 @@ on: jobs: publish: name: Publish package and documentation - uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.5.1 + uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.5.2 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 index 01020d09..365556b2 100644 --- 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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.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 }} @@ -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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.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 @@ -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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.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 index af31ddbe..6c35aae8 100644 --- 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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.5.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 index cf51b592..9166aea7 100644 --- 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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.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. @@ -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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.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 index 36989843..010cfdc6 100644 --- 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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.5.2 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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.5.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 index be8ce795..b731a10d 100644 --- 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.1 + uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.5.2 if: github.repository_owner == 'SINTEF' with: git_username: "Casper Welzel Andersen"