v2.5.2

Include extra toggle for releasing latest MkDocs version

It is now possible to not release a latest MkDocs documentation version. This is a feature specific to releasing documentation in the MkDocs framework and is backwards compatible, as the default value is true, i.e., keeping with the current behavior if no action is taken by users.

Furthermore, some GH Actions were updated.

Changelog

v2.5.2 (2023-10-04)

Full Changelog

Implemented enhancements:

• Toggle latest alias MkDocs release #187

Merged pull requests:

• [Auto-generated] Update dependencies #189 (@TEAM4-0)
• Add mkdocs_update_latest bool input #188 (@CasperWA)
• [Auto-generated] Update dependencies #185 (@TEAM4-0)
• [Auto-generated] Update dependencies #177 (@TEAM4-0)

* This Changelog was automatically generated by github_changelog_generator

v2.5.1

Patch release for regression fix

This release fixes a regression for the --full-docs-dir input to the docs-api-reference pre-commit hook, which happened after implementing Windows support.

Furthermore, the CD - Release callable workflow has been made less strict concerning release tag naming. Semantic versioning is still required.

Changelog

v2.5.1 (2023-08-30)

Full Changelog

Fixed bugs:

• Regression in --full-docs-dir input #174
• Too strict release tag name requirements #172

Merged pull requests:

• Fix --full-docs-dir regression #175 (@CasperWA)
• Remove requirement for release to start with 'v' #173 (@CasperWA)

* This Changelog was automatically generated by github_changelog_generator

v2.5.0

Support for Windows

Support and tests for Windows has been added for the pre-commit hooks.

The documentation has been updated as well with an improved distinction between single and multi-line inputs.

Changelog

v2.5.0 (2023-08-29)

Full Changelog

Fixed bugs:

• pylint_options not working as intended #169
• Pre-commit for documentation not working on windows #160

Merged pull requests:

• Parse pylint_options depending on newlines #170 (@CasperWA)
• Support Windows for pre-commit hook usage #165 (@CasperWA)
• [Auto-generated] Update dependencies #159 (@TEAM4-0)
• [Auto-generated] Update dependencies #156 (@TEAM4-0)
• [Auto-generated] Update dependencies #154 (@TEAM4-0)

* This Changelog was automatically generated by github_changelog_generator

v2.4.0

Several QoL updates and ignore rule fixes

The ignore input has been given an overhaul for more easy readability in the code, as well as ensuring it works as intended.
There is still an open issue regarding version ranges, which should be fixed (#141).

Several other QoL updates have been implemented throughout the codebase, callable workflows and more.

Changelog

v2.4.0 (2023-05-23)

Full Changelog

Implemented enhancements:

• Automatically merge CI workflow to update deps #101
• Support Sphinx for documentation building #90
• Add hook for using the update-deps task #24

Fixed bugs:

• Flawed logic #152
• Error in workflow #150
• Issues with the ignore-functionality of ci-cd update-deps #130

Closed issues:

• Error in .github/workflows/ci_automerge_prs.yml which makes automerging fail in outside repos #139

Merged pull requests:

• Fix logic for checking documentation framework #153 (@CasperWA)
• Fix typos in workflows #151 (@CasperWA)
• [Auto-generated] Update dependencies #143 (@TEAM4-0)
• Fix ignore functionality (especially for 'version' rules) #140 (@CasperWA)
• Add update-pyproject pre-commit hook #128 (@CasperWA)
• Activate auto-merge for pyproject.toml update PRs #114 (@CasperWA)
• Support Sphinx #92 (@CasperWA)

* This Changelog was automatically generated by github_changelog_generator

v2.3.1

Update GitHub Actions

A patch update to ensure the latest GitHub Actions are used in the callable workflows.

Changelog

v2.3.1 (2023-04-13)

Full Changelog

Merged pull requests:

• [Auto-generated] Update dependencies #138 (@TEAM4-0)
• [Auto-generated] Update dependencies #131 (@TEAM4-0)

* This Changelog was automatically generated by github_changelog_generator

v2.3.0

GitHub usernames in release changelogs

The GitHub release changelogs added by CD - Release will now use GitHub handles/usernames instead of markdown links, which will make GitHub aware of the contributors to each release.

The release_branch input for the CD - Release callable workflow is now required.

As a hot-fix, the CI - Check pyproject.toml dependencies has been fixed when calling ci-cd update-deps, where a wrongly named option argument was used.

Changelog

v2.3.0 (2023-03-24)

Full Changelog

Implemented enhancements:

• Use GH usernames for release changelogs #102

Fixed bugs:

• Wrongly named option used in callable workflow #125
• Use codecov upload token #119

Merged pull requests:

• Use CODECOV_TOKEN secret in CI #127 (@CasperWA)
• Use the proper "ignore" option name for update-deps #126 (@CasperWA)
• Use GitHub usernames in changelogs for releases #115 (@CasperWA)

* This Changelog was automatically generated by github_changelog_generator

v2.2.1

Hotfix for CI - Activate auto-merging for PRs

Referencing the changes input in this callable workflow was flawed in two places and has now been fixed.

Changelog

v2.2.1 (2023-03-15)

Full Changelog

Fixed bugs:

• Typo in auto-merge callable workflow #117
• Fix GH Actions variable naming #120 (CasperWA)
• Fix typo in auto merge workflow #118 (CasperWA)

Merged pull requests:

• [Auto-generated] Update dependencies #121 (TEAM4-0)

* This Changelog was automatically generated by github_changelog_generator

v2.2.0

More version control for updating pyproject.toml

The new ignore option adds more version when determining whether a dependency should be updated or not when running the CI - Check pyproject.toml dependencies workflow.
To learn more about how it works, see this part of the updated documentation.

The Python API of the repository has also been documented and added to the published documentation. Unfortunately, the actual invoke functions are not rendered. This should be fixed in a later release.

Changelog

v2.2.0 (2023-03-10)

Full Changelog

Implemented enhancements:

• Add API reference documentation for this repository #113
• Allow to skip or keep dependency at certain level #95

Fixed bugs:

• fail_fast should still make update-deps task fail #112

Merged pull requests:

• Implement ignore option for update-deps task #111 (CasperWA)
• Add API reference documentation for ci-cd #110 (CasperWA)
• Update Python API #109 (CasperWA)
• [Auto-generated] Update dependencies #107 (TEAM4-0)

* This Changelog was automatically generated by github_changelog_generator

v2.1.0

Allow changes prior to auto-merging

You can now perform custom changes prior to activating auto-merging (of dependency PRs). This is done through the perform_changes input for the CI - Activate auto-merging for PRs callable workflow.

Furthermore, a fix was implemented to always prefer the PAT secret over the GITHUB_TOKEN, if the PAT is available.

Changelog

v2.1.0 (2023-02-07)

Full Changelog

Implemented enhancements:

• Use custom token when possible #104
• Extend "automerge" workflow with changes #69

Closed issues:

• Acknowledge testing dependencies in pyproject.toml #93

Merged pull requests:

• Always try to use PAT prior to GITHUB_TOKEN #105 (CasperWA)
• [Auto-generated] Update dependencies #103 (TEAM4-0)
• [Auto-generated] Update dependencies #97 (TEAM4-0)
• Changes prior to auto-merge #88 (CasperWA)

* This Changelog was automatically generated by github_changelog_generator

v2.0.0

New major version - no more moving vMAJOR tag

The main reason for moving to v2, is to avoid having a dynamic vMAJOR tag (e.g., v1). For backwards compatibility, the current v1 tag will continue to exist, but there will not be a v2 tag.
This is mainly due to issues with pre-commit when updating the version it would always update to v1, which it would then not update locally further, due to the tag being dynamic.
This also means a full version must be used in the callable workflows.

Changelog

v2.0.0 (2022-12-06)

Full Changelog

Implemented enhancements:

• Make test: true actually work for "CD - Release" #83

Fixed bugs:

• Bad usage of backticks in warning message #79

Closed issues:

• Drop using a vMAJOR dynamic tag #81

Merged pull requests:

• [Auto-generated] Update dependencies #85 (TEAM4-0)
• Changed to vMajor tag for pre-commit in ci_update_dependencies.yml #82 (francescalb)
• Use quotes instead of backticks in warning message #80 (CasperWA)

* This Changelog was automatically generated by github_changelog_generator