Improved the violation message of DOC105: the arguments with inconsistent
type hints are now shown in the violation message to make violation
correction much easier
A new config option --show-filenames-in-every-violation-message (or
-sfn), which makes it more convenient to jump to the corresponding line
in IDEs by clicking on the violation message in the terminal
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 7 updates:
0.3.8
0.4.1
3.5.1
3.5.2
9.5.3
9.5.12
0.24.0
0.24.1
0.8.0
0.9.1
3.0.3
3.1.0
0.8.0
0.9.1
Updates
pydoclint
from 0.3.8 to 0.4.1Release notes
Sourced from pydoclint's releases.
Changelog
Sourced from pydoclint's changelog.
Commits
af2c326
Update changelog3a5e4b0
Remove useless argument--src
(#124)70eb3c8
Fix double quotes in Literal type hint (#123)d2b4b99
Include args with different type hints in DOC105 msg (#120)fa41757
Add option to show filename for each violation msg (#119)b8b4396
Add py312 to CI pipeline01893df
Exclude venv folders in flake8 (#116)676847e
Documenting tool integration (#104)75e485b
Fix false positive DOC203 in property methods (#115)55c0fde
Explain why allow-init-docstring defaults to FalseUpdates
markdown
from 3.5.1 to 3.5.2Release notes
Sourced from markdown's releases.
Changelog
Sourced from markdown's changelog.
Commits
08dacae
Bump version to 3.5.2e466f38
Fix handling of bogus comments.a2a9c53
Update change log link in README.mdcef5afe
Update Changelog URL5d7f255
Fix missing search in docsbc14d59
Split changelog workflows to separate logic on when each gets run.9b06df2
ghp-import it not a command moduledac7977
Fix a minor oversight in #1407dcd69b1
Update docs deploy scriptsa63e6f3
Fix edge-case crash in InlineProcessorUpdates
mkdocs-material
from 9.5.3 to 9.5.12Release notes
Sourced from mkdocs-material's releases.
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
5108432
Updated changelogd366a45
Fixed instant navigation removing color theme tags6219f3d
Merge branch 'master' of github.com:squidfunk/mkdocs-materialc7bde2d
Formattingde46c41
Fixed document observable not emitting current document7b83b57
Updated contributing guide (#6843)6c2e029
Updated Premium sponsorsb5a5fde
Updated dependenciesc3a1e79
Merge branch 'master' of github.com:squidfunk/mkdocs-materialca7e952
Fixed 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
d716a88
chore: Prepare release 0.24.1c161d26
ci: Remove type ignore comment now that it's fixed in autorefs89f752a
style: Format2fe2b47
chore: Template upgrade080ddad
docs: Fix insiders pagecdd946c
docs: Enable lang class and automatic inline highlight21380ae
docs: Remove mention of directory watchingf553684
ci: Type ignore comment waiting for fix in autorefsa7a2907
refactor: Support new pymdownx-highlight optionsb5236b4
refactor: 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
b3925ca
Clean up release notes for 0.9.1 (#232)ae48810
Clean up release notes for 0.9.1fb2851a
Initialize repos to version 0.9.1 (#231)1498b05
Initialize repos to version 0.9.1017b18e
Clear release notes (#228)4ca01ac
Clear release notes3e198ce
Prepare release notes for v0.9.0 (#227)665c447
Remove placeholder from RELEASE_NOTES.md9545f59
Add summary to release notes3258f97
Remove conflict markers from RELEASE_NOTES.mdUpdates
pylint
from 3.0.3 to 3.1.0Commits
053c2c3
Bump pylint to 3.1.0, update changelogc954636
Upgrade release documentation, and contributors.txt7300ed2
Discover.pyi
files (#9241)9dbf3df
Merge maintenance 3.0.x into main following 3.0.4 release (#9459)28e89b0
Remove changelog fragments pertaining to 3.0.44332ea1
Merge branch 'maintenance/3.0.x' into main following 3.0.4 release8115381
Bump 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)f499686
Update 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
b3925ca
Clean up release notes for 0.9.1 (#232)ae48810
Clean up release notes for 0.9.1fb2851a
Initialize repos to version 0.9.1 (#231)1498b05
Initialize repos to version 0.9.1017b18e
Clear release notes (#228)4ca01ac
Clear release notes3e198ce
Prepare release notes for v0.9.0 (#227)665c447
Remove placeholder from RELEASE_NOTES.md9545f59
Add summary to release notes3258f97
Remove 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