v2.6.0

Properly handle version specifiers

This version greatly improves on the version specifier handling when updating the pyproject.toml file using either the callable workflow CI - Check pyproject.toml dependencies or the pre-commit hook Update dependencies in pyproject.toml.

It now utilizes the same logic as is implemented in the pip package, namely the packaging Python library to handle the dependencies and requirements listed in the pyproject.toml file.

To an extent, there is also support for version markers, specifically, specifying a dependency's validity according to a Python language version, e.g., my_package~=1.3; python_version < '3.8'. However, this support is limited in its scope, and does not support the full reasoning logic otherwise provided by the marker handling in packaging, meaning for example if you specify different Python language version requirements based on the OS, this may not be respected as intended by the user.

Changelog

v2.6.0 (2023-11-17)

Full Changelog

Implemented enhancements:

• Modularize update_deps.py further #148

Fixed bugs:

• Ensure version dependency ranges are respected when updating #141

Merged pull requests:

• [Auto-generated] Update dependencies #214 (@TEAM4-0)
• [Auto-generated] Check & update dependencies (pyproject.toml) #213 (@TEAM4-0)
• [Auto-generated] Check & update dependencies (pyproject.toml) #206 (@TEAM4-0)
• [Auto-generated] Update dependencies #204 (@TEAM4-0)
• Handle version specifiers #190 (@CasperWA)

* This Changelog was automatically generated by github_changelog_generator

v2.5.3

Several fixes

Several fixes for the CI - Check dependencies callable workflow and its underlying task update_deps() have been implemented.
This fixes issues with spacing immediately prior to version specifiers, multiple parallel jobs each creating PRs with clashing branch names, and suppressing unnecessary warnings.

Changelog

v2.5.3 (2023-10-25)

Full Changelog

Implemented enhancements:

• Avoid warning for inter-relative extra dependencies #198
• Allow branch name customization #196

Fixed bugs:

• A PR is not opened for CI - Check dependencies #195
• Ignore options not parseable #194

Merged pull requests:

• Add project name by default to already_handled_packages #202 (@CasperWA)
• Customize branch name #201 (@CasperWA)
• Handle package-specifier spacing #197 (@CasperWA)

* This Changelog was automatically generated by github_changelog_generator

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