Changelog¶
Unreleased changes (2024-12-02)¶
Implemented enhancements:
- Support Python 3.14 (pre) #294
Closed issues:
- Example for using trusted puclihser uses wrong key #299
Merged pull requests:
- [Auto-generated] Update dependencies #308 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #307 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #306 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #304 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #303 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #301 (pre-commit-ci[bot])
- Corrected a typo in pypi publishing example, package-dir -> packages-dir #300 (francescalb)
- [pre-commit.ci] pre-commit autoupdate #298 (pre-commit-ci[bot])
- Add support for Python 3.14 #295 (CasperWA)
v2.8.3 (2024-10-15)¶
Update GitHub Actions¶
Update the used GitHub Actions in the callable workflows.
DX¶
Update development tools and dependencies for an improved developer experience.
Merged pull requests:
- [Auto-generated] Update dependencies #297 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #293 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #292 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #291 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #290 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #289 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #288 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #287 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #283 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #282 (pre-commit-ci[bot])
v2.8.2 (2024-08-22)¶
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.
Implemented enhancements:
- Support self-hosted runners #279
Merged pull requests:
v2.8.1 (2024-08-22)¶
Support custom PyPI indices¶
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.
For more information on the specific workflow, see the documentation.
Implemented enhancements:
- Support custom pip index URL(s) #276
Merged pull requests:
- Support adding pip index URLs #277 (CasperWA)
- [pre-commit.ci] pre-commit autoupdate #275 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #274 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #273 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #272 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #271 (pre-commit-ci[bot])
v2.8.0 (2024-07-29)¶
Support Trusted Publishers from PyPI¶
Trusted Publishers from PyPI is now supported via uploading the distribution(s) as artifacts (for more information about GitHub Actions artifacts, see the GitHub Docs).
Breaking change: This is not a "true" breaking change - but it may cause certain workflows to fail that uses the callable workflow CD - Release: The parameter publish_on_pypi
has become required, meaning one must provide it in the with
section of the calling workflow. For more information, see the documentation page for the CD - Release workflow.
DX updates¶
Several fixes from the development tools have been implemented into the code base.
Implemented enhancements:
- Support new PyPI Trusted Publisher #180
Merged pull requests:
- [pre-commit.ci] pre-commit autoupdate #268 (pre-commit-ci[bot])
- Push for PyPI Trusted Publisher usage #267 (CasperWA)
- [pre-commit.ci] pre-commit autoupdate #266 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #265 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #264 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #263 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #262 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #261 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #259 (pre-commit-ci[bot])
- [pre-commit.ci] pre-commit autoupdate #257 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #255 (TEAM4-0)
- [pre-commit.ci] pre-commit autoupdate #254 (pre-commit-ci[bot])
- [Auto-generated] Update dependencies #250 (TEAM4-0)
- [Auto-generated] Update dependencies #247 (TEAM4-0)
v2.7.4 (2024-02-29)¶
Implemented enhancements:
- Use Python versioning regex in
setver
#243
Merged pull requests:
v2.7.3 (2024-02-14)¶
Fixed bugs:
- Use
git add -- .
instead ofgit commit -a
#236
Merged pull requests:
- [Auto-generated] Update dependencies #241 (TEAM4-0)
- Use git add -- . instead of git commit -a #240 (CasperWA)
- [Auto-generated] Update dependencies #239 (TEAM4-0)
v2.7.2 (2024-01-13)¶
Fixed bugs:
- Support first release #232
Closed issues:
- Use ruff instead of pylint (and isort) in code base #191
Merged pull requests:
- [Auto-generated] Update dependencies #235 (TEAM4-0)
- Go through another env var to set --since-tag #233 (CasperWA)
- [Auto-generated] Update dependencies #231 (TEAM4-0)
- Update to ruff (instead of pylint (and isort)) #192 (CasperWA)
v2.7.1 (2023-12-07)¶
v2.7.0 (2023-12-07)¶
Implemented enhancements:
- Toggle allowing invalid package name chars #208
- Support all newer Python versions #207
- Support not using a permanent dependencies branch #183
Fixed bugs:
Closed issues:
- Update to non-deprecated inputs in Actions #216
Merged pull requests:
- [Auto-generated] Update dependencies #228 (TEAM4-0)
- Toggle for skipping dependency if it cannot be parsed #224 (CasperWA)
- [Auto-generated] Update dependencies #223 (TEAM4-0)
- Use non-deprecated actions inputs #219 (CasperWA)
- Support Python 3.11, 3.12 and 3.13 #205 (CasperWA)
- Make using dependencies branch toggleable #184 (CasperWA)
v2.6.0 (2023-11-17)¶
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)
v2.5.3 (2023-10-25)¶
Implemented enhancements:
Fixed bugs:
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)
v2.5.2 (2023-10-04)¶
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)
v2.5.1 (2023-08-30)¶
Fixed bugs:
Merged pull requests:
- Fix --full-docs-dir regression #175 (CasperWA)
- Remove requirement for release to start with 'v' #173 (CasperWA)
v2.5.0 (2023-08-29)¶
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)
v2.4.0 (2023-05-23)¶
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)
v2.3.1 (2023-04-13)¶
Merged pull requests:
- [Auto-generated] Update dependencies #138 (TEAM4-0)
- [Auto-generated] Update dependencies #131 (TEAM4-0)
v2.3.0 (2023-03-24)¶
Implemented enhancements:
- Use GH usernames for release changelogs #102
Fixed bugs:
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)
v2.2.1 (2023-03-15)¶
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:
v2.2.0 (2023-03-10)¶
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 makeupdate-deps
task fail #112
Merged pull requests:
- Implement
ignore
option forupdate-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)
v2.1.0 (2023-02-07)¶
Implemented enhancements:
Closed issues:
- Acknowledge testing dependencies in pyproject.toml #93
Merged pull requests:
- Always try to use
PAT
prior toGITHUB_TOKEN
#105 (CasperWA) - [Auto-generated] Update dependencies #103 (TEAM4-0)
- [Auto-generated] Update dependencies #97 (TEAM4-0)
- Changes prior to auto-merge #88 (CasperWA)
v2.0.0 (2022-12-06)¶
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)
v1.3.5 (2022-11-17)¶
Fixed bugs:
- Undo commit d525ea0f069b6615aa352a7f385c21b31f29b985 #77
Merged pull requests:
- Make
--strict
toggleable formkdocs build
#78 (CasperWA) - [Auto-generated] Update dependencies #76 (TEAM4-0)
v1.3.4 (2022-10-31)¶
Implemented enhancements:
- Support setting full versions in pre-commit config #72
Merged pull requests:
v1.3.3 (2022-10-12)¶
Implemented enhancements:
- Support setting python version restrictions in dependencies #70
Merged pull requests:
v1.3.2 (2022-10-10)¶
Fixed bugs:
- Don't change
.pages
in API ref hook #66
Merged pull requests:
- [Auto-generated] Update dependencies #68 (TEAM4-0)
- Ensure
.pages
does not get mkdocstrings option #67 (CasperWA)
v1.3.1 (2022-10-06)¶
Fixed bugs:
- Nested modules not represented properly #64
Merged pull requests:
v1.3.0 (2022-10-05)¶
Implemented enhancements:
- Custom API ref file options #57
- Test installing Python package after building it #56
- Support multi-package repositories #55
- Use custom Python version for CI tests #54
Fixed bugs:
Closed issues:
- Documentation issue #52
Merged pull requests:
- Update local workflows with new input names #63 (CasperWA)
- Custom Python versions for jobs #61 (CasperWA)
- Custom API reference options #60 (CasperWA)
- Fix documentation typos #59 (CasperWA)
- Support multiple packages in the same repo #58 (CasperWA)
- [Auto-generated] Update dependencies #50 (TEAM4-0)
- [Auto-generated] Update dependencies #48 (TEAM4-0)
v1.2.2 (2022-08-24)¶
Fixed bugs:
- API reference links depends on installation type #46
Merged pull requests:
v1.2.1 (2022-08-23)¶
Fixed bugs:
- Properly point to API reference files #44
Merged pull requests:
v1.2.0 (2022-07-18)¶
Implemented enhancements:
Fixed bugs:
Closed issues:
Merged pull requests:
- [Auto-generated] Update dependencies #39 (TEAM4-0)
- Convert to SINTEF owner instead of CasperWA #38 (CasperWA)
- Update README title and description + funding #36 (CasperWA)
- Basic CI tests workflow #33 (CasperWA)
v1.1.2 (2022-07-08)¶
Implemented enhancements:
Fixed bugs:
- Fix usage of invoke tasks for lists #30
- Default
args
fordocs-landing-page
doesn't work #27 - Update internal Python package along with releases #26
Merged pull requests:
v1.1.1 (2022-07-06)¶
Fixed bugs:
- Hooks not working externally #21
Merged pull requests:
v1.1.0 (2022-07-06)¶
Implemented enhancements:
- New pre-commit hooks for invoke tasks #16
Merged pull requests:
v1.0.1 (2022-07-06)¶
Fixed bugs:
- Ensure PREVIOUS_VERSION can be retrieved if input not given #19
- Fix condition for running steps in CI/CD workflow #18
Closed issues:
- Update documentation to
@v1
#15
v1.0.0 (2022-07-06)¶
Implemented enhancements:
- Use proper option for changelog generator instead of moving file afterwards #13
- Update CHANGELOG with unreleased stuff when updating default branch #11
- Update to new repo name #8
- Allow testing/debugging CI/CD workflow #6
- Make "FIRST_RELEASE" bool more robust #3
Fixed bugs:
- Exclude tags from PREVIOUS_VERSION in release workflow #17
- Update local workflow for updated CI/CD workflow #12
- Fix links for various "default" PR bodies and tag messages #9
- API Reference creation not working #7
- Ensure the permanent dependencies branch is always updated #4
Closed issues:
Merged pull requests:
v0.1.0 (2022-07-05)¶
Merged pull requests:
* This Changelog was automatically generated by github_changelog_generator