This release brings support for pytest 8, a couple of bug fixes and many improvements to the cookiecutter template.
Upgrading
Once you upgraded, you'll be able to upgrade to pytest 8, and indirectly to sybil 6, which includes types hints. If you do so, you should remove the mypy exception for sybil in the pyproject.toml file.
Search for the tool.mypy.overrides section and remove the "sybil", "sybil.*" enties from the module list.
Cookiecutter template
To upgrade without regenerating the project, you can follow these steps:
Run the following command to add the new pylint ignore rules:
sed '/ # Checked by flake8/a\ "redefined-outer-name",\n "unused-import",' -i pyproject.toml
It is recommended to update this rule in your repository to use the new bypass rule for the Protect version branches ruleset that allows maintainers to force-merge.
You can do this by re-importing the ruleset or manually:
Go to the repository settings -> Rules -> Rulesets -> Protect version branches -> Bypass list -> Add bypass -> Select Maintain role and change the dropdown bypass rule to use Pull requests instead of Always.
The labeler action was upgraded to 5.0.0. This needs a new configuration file.
If you haven't diverged much from the default configuration (and you are not using exclusion rules), you can update the configuration file by running this script in the root of your repository:
This release brings support for pytest 8, a couple of bug fixes and many improvements to the cookiecutter template.
Upgrading
Once you upgraded, you'll be able to upgrade to pytest 8, and indirectly to sybil 6, which includes types hints. If you do so, you should remove the mypy exception for sybil in the pyproject.toml file.
Search for the tool.mypy.overrides section and remove the "sybil", "sybil.*" enties from the module list.
Cookiecutter template
To upgrade without regenerating the project, you can follow these steps:
Run the following command to add the new pylint ignore rules:
sed '/ # Checked by flake8/a\ "redefined-outer-name",\n "unused-import",' -i pyproject.toml
It is recommended to update this rule in your repository to use the new bypass rule for the Protect version branches ruleset that allows maintainers to force-merge.
You can do this by re-importing the ruleset or manually:
Go to the repository settings -> Rules -> Rulesets -> Protect version branches -> Bypass list -> Add bypass -> Select Maintain role and change the dropdown bypass rule to use Pull requests instead of Always.
The labeler action was upgraded to 5.0.0. This needs a new configuration file.
If you haven't diverged much from the default configuration (and you are not using exclusion rules), you can update the configuration file by running this script in the root of your repository:
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
- `@dependabot ignore minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
- `@dependabot ignore ` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore ` will remove all of the ignore conditions of the specified dependency
- `@dependabot unignore ` will remove the ignore condition of the specified dependency and ignore conditions
Bumps the optional group with 6 updates:
0.4.00.4.19.5.89.5.120.24.00.24.10.8.00.9.13.0.33.1.00.8.00.9.1Updates
pydoclintfrom 0.4.0 to 0.4.1Release notes
Sourced from pydoclint's releases.
Changelog
Sourced from pydoclint's changelog.
Commits
af2c326Update changelog3a5e4b0Remove useless argument--src(#124)70eb3c8Fix double quotes in Literal type hint (#123)Updates
mkdocs-materialfrom 9.5.8 to 9.5.12Release notes
Sourced from mkdocs-material's releases.
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
5108432Updated changelogd366a45Fixed instant navigation removing color theme tags6219f3dMerge branch 'master' of github.com:squidfunk/mkdocs-materialc7bde2dFormattingde46c41Fixed document observable not emitting current document7b83b57Updated contributing guide (#6843)6c2e029Updated Premium sponsorsb5a5fdeUpdated dependenciesc3a1e79Merge branch 'master' of github.com:squidfunk/mkdocs-materialca7e952Fixed privacy plugin not handling URL-encoded pathnamesUpdates
mkdocstrings[python]from 0.24.0 to 0.24.1Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
d716a88chore: Prepare release 0.24.1c161d26ci: Remove type ignore comment now that it's fixed in autorefs89f752astyle: Format2fe2b47chore: Template upgrade080ddaddocs: Fix insiders pagecdd946cdocs: Enable lang class and automatic inline highlight21380aedocs: Remove mention of directory watchingf553684ci: Type ignore comment waiting for fix in autorefsa7a2907refactor: Support new pymdownx-highlight optionsb5236b4refactor: Backup anchors with id and no href, for compatibility with autorefs...Updates
frequenz-repo-config[api]from 0.8.0 to 0.9.1Release notes
Sourced from frequenz-repo-config[api]'s releases.
... (truncated)
Commits
b3925caClean up release notes for 0.9.1 (#232)ae48810Clean up release notes for 0.9.1fb2851aInitialize repos to version 0.9.1 (#231)1498b05Initialize repos to version 0.9.1017b18eClear release notes (#228)4ca01acClear release notes3e198cePrepare release notes for v0.9.0 (#227)665c447Remove placeholder from RELEASE_NOTES.md9545f59Add summary to release notes3258f97Remove conflict markers from RELEASE_NOTES.mdUpdates
pylintfrom 3.0.3 to 3.1.0Commits
053c2c3Bump pylint to 3.1.0, update changelogc954636Upgrade release documentation, and contributors.txt7300ed2Discover.pyifiles (#9241)9dbf3dfMerge maintenance 3.0.x into main following 3.0.4 release (#9459)28e89b0Remove changelog fragments pertaining to 3.0.44332ea1Merge branch 'maintenance/3.0.x' into main following 3.0.4 release8115381Bump pylint to 3.0.4, update changelog (#9458)4bf3524[false-negative] Fix for consider-using-min/max-builtin (#9127)8c24b1e[pre-commit.ci] pre-commit autoupdate (#9448)f499686Update astroid version to 3.1.0 (#9457)Updates
frequenz-repo-config[extra-lint-examples]from 0.8.0 to 0.9.1Release notes
Sourced from frequenz-repo-config[extra-lint-examples]'s releases.
... (truncated)
Commits
b3925caClean up release notes for 0.9.1 (#232)ae48810Clean up release notes for 0.9.1fb2851aInitialize repos to version 0.9.1 (#231)1498b05Initialize repos to version 0.9.1017b18eClear release notes (#228)4ca01acClear release notes3e198cePrepare release notes for v0.9.0 (#227)665c447Remove placeholder from RELEASE_NOTES.md9545f59Add summary to release notes3258f97Remove conflict markers from RELEASE_NOTES.mdDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show