poetry
poetry copied to clipboard
Fix poetry-install pre-commit hook configuration
- Change language from python to system for poetry-install hook
- Add default args: ["--sync"] to poetry-install hook
- Update documentation with warning about versions up to 2.2.1
Resolves: #9393
Summary by Sourcery
Configure the poetry-install pre-commit hook to use the system language with default sync arguments and update documentation with a warning for versions up to 2.2.1
Enhancements:
- Change the poetry-install hook language from python to system
- Add default args ["--sync"] to the poetry-install hook
Documentation:
- Add a warning about version mismatches up to 2.2.1 and update documentation to reflect the new default sync behavior
Reviewer's guide (collapsed on small PRs)
Reviewer's Guide
The PR updates the poetry-install pre-commit hook to use system language and include default sync arguments, and enhances the documentation with a warning about prior misconfigurations and details on the default args.
Flow diagram for updated poetry-install pre-commit hook configuration
flowchart TD
A[".pre-commit-config.yaml"] --> B["poetry-install hook"]
B --> C["language: system"]
B --> D["args: [--sync]"]
B --> E["entry: poetry install"]
B --> F["stages: post-checkout, post-merge"]
Flow diagram for documentation update warning about poetry-install hook versions
flowchart TD
A["Documentation"] --> B["Warning for versions <= 2.2.1"]
B --> C["language: python (incorrect)"]
A --> D["Info for versions >= 2.2.2"]
D --> E["language: system"]
D --> F["args: [--sync]"]
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Updated pre-commit hook configuration to system language with sync args |
|
.pre-commit-hooks.yaml |
| Enhanced documentation with warnings and default argument details |
|
docs/pre-commit-hooks.md |
Possibly linked issues
- #9393: The PR updates the poetry-install hook's configuration and documentation to clarify its behavior, directly addressing the misleading information in the issue.
- #9393: PR updates
poetry-installhook with--syncfunctionality, addressing the issue's stated limitations.
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
- Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. - Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.