Skip to content

Commit

Permalink
Release v2.2.0 - Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
TEAM4-0 committed Mar 10, 2023
1 parent 180aa98 commit 7385d74
Show file tree
Hide file tree
Showing 15 changed files with 41 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cd_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ jobs:
python -m pip install -U pip
pip install -U setuptools wheel build
pip install ${EDITABLE}.${{ inputs.install_extras }}
pip install git+https://github.com/SINTEF/ci-cd.git@v2.1.0
pip install git+https://github.com/SINTEF/ci-cd.git@v2.2.0
- name: Update changelog
uses: CharMixer/auto-changelog-action@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci_cd_updated_default_branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,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.1.0
pip install git+https://github.com/SINTEF/ci-cd.git@v2.2.0
- name: Set up git user
if: env.RELEASE_RUN == 'false'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci_check_pyproject_dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.1.0
pip install git+https://github.com/SINTEF/ci-cd.git@v2.2.0
- name: Set up git user
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,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.1.0
pip install git+https://github.com/SINTEF/ci-cd.git@v2.2.0
- name: Update API Reference
if: inputs.update_python_api_ref
Expand Down
24 changes: 22 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,38 @@

## [Unreleased](https://github.com/SINTEF/ci-cd/tree/HEAD)

[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.1.0...HEAD)
[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.2.0...HEAD)

**Implemented enhancements:**

- Use custom token when possible [\#104](https://github.com/SINTEF/ci-cd/issues/104)
- Allow to skip or keep dependency at certain level [\#95](https://github.com/SINTEF/ci-cd/issues/95)

## [v2.2.0](https://github.com/SINTEF/ci-cd/tree/v2.2.0) (2023-03-10)

[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.1.0...v2.2.0)

**Implemented enhancements:**

- Add API reference documentation for this repository [\#113](https://github.com/SINTEF/ci-cd/issues/113)

**Fixed bugs:**

- `fail_fast` should still make `update-deps` task fail [\#112](https://github.com/SINTEF/ci-cd/issues/112)

**Merged pull requests:**

- Implement `ignore` option for `update-deps` task [\#111](https://github.com/SINTEF/ci-cd/pull/111) ([CasperWA](https://github.com/CasperWA))
- Add API reference documentation for `ci-cd` [\#110](https://github.com/SINTEF/ci-cd/pull/110) ([CasperWA](https://github.com/CasperWA))
- Update Python API [\#109](https://github.com/SINTEF/ci-cd/pull/109) ([CasperWA](https://github.com/CasperWA))
- \[Auto-generated\] Update dependencies [\#107](https://github.com/SINTEF/ci-cd/pull/107) ([TEAM4-0](https://github.com/TEAM4-0))

## [v2.1.0](https://github.com/SINTEF/ci-cd/tree/v2.1.0) (2023-02-07)

[Full Changelog](https://github.com/SINTEF/ci-cd/compare/v2.0.0...v2.1.0)

**Implemented enhancements:**

- Use custom token when possible [\#104](https://github.com/SINTEF/ci-cd/issues/104)
- Extend "automerge" workflow with changes [\#69](https://github.com/SINTEF/ci-cd/issues/69)

**Closed issues:**
Expand Down
2 changes: 1 addition & 1 deletion ci_cd/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""CI/CD Tools. Tiny package to run invoke tasks as a standalone program."""
__version__ = "2.1.0"
__version__ = "2.2.0"
__author__ = "Casper Welzel Andersen"
__author_email__ = "casper.w.andersen@sintef.no"
2 changes: 1 addition & 1 deletion docs/hooks/docs_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ It is meant to be complete as is.
```yaml
repos:
- repo: https://github.com/SINTEF/ci-cd
rev: v2.1.0
rev: v2.2.0
hooks:
- id: docs-api-reference
args:
Expand Down
2 changes: 1 addition & 1 deletion docs/hooks/docs_landing_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ It is meant to be complete as is.
```yaml
repos:
- repo: https://github.com/SINTEF/ci-cd
rev: v2.1.0
rev: v2.2.0
hooks:
- id: docs-landing-page
args:
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CI/CD tools

**Current version to use:** `v2.1.0`
**Current version to use:** `v2.2.0`

Use tried and tested continuous integration (CI) and continuous deployment (CD) tools from this repository.

Expand Down
4 changes: 2 additions & 2 deletions docs/workflows/cd_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.1.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.2.0/.github/workflows/_local_cd_release.yml) calling the _CD Release_ workflow.

Some notes to consider and respect when using `version_update_changes` are:

Expand Down Expand Up @@ -108,7 +108,7 @@ on:
jobs:
publish:
name: Publish package and documentation
uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.2.0
if: github.repository == 'SINTEF/my-python-package' && startsWith(github.ref, 'refs/tags/v')
with:
git_username: "Casper Welzel Andersen"
Expand Down
6 changes: 3 additions & 3 deletions docs/workflows/ci_automerge_prs.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ on:
jobs:
update-dependency-branch:
name: Call external workflow
uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.2.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 }}
Expand All @@ -73,7 +73,7 @@ on:
jobs:
update-dependency-branch:
name: Call external workflow
uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.2.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
Expand All @@ -97,7 +97,7 @@ on:
jobs:
update-dependency-branch:
name: Call external workflow
uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.2.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
Expand Down
2 changes: 1 addition & 1 deletion docs/workflows/ci_cd_updated_default_branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ on:
jobs:
updates-to-stable:
name: Call external workflow
uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.2.0
if: github.repository_owner == 'SINTEF'
with:
git_username: "Casper Welzel Andersen"
Expand Down
4 changes: 2 additions & 2 deletions docs/workflows/ci_check_pyproject_dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.0
uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.2.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.
Expand Down Expand Up @@ -88,7 +88,7 @@ on:
jobs:
check-dependencies:
name: Call external workflow
uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.2.0
if: github.repository_owner == 'SINTEF'
with:
git_username: "Casper Welzel Andersen"
Expand Down
4 changes: 2 additions & 2 deletions docs/workflows/ci_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ on:
jobs:
tests:
name: Run basic tests
uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.2.0
with:
python_version_pylint_safety: "3.8"
python_version_docs: "3.7"
Expand Down Expand Up @@ -164,7 +164,7 @@ on:
jobs:
tests:
name: Run basic tests
uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.2.0
with:
python_version_pylint_safety: "3.8"
python_version_docs: "3.7"
Expand Down
2 changes: 1 addition & 1 deletion docs/workflows/ci_update_dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ on:
jobs:
check-dependencies:
name: Call external workflow
uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.1.0
uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.2.0
if: github.repository_owner == 'SINTEF'
with:
git_username: "Casper Welzel Andersen"
Expand Down

0 comments on commit 7385d74

Please sign in to comment.