Skip to content

Comments

docs: add docs about include-groups#10166

Merged
radoering merged 3 commits intopython-poetry:mainfrom
finswimmer:docs-nested-groups
Jun 29, 2025
Merged

docs: add docs about include-groups#10166
radoering merged 3 commits intopython-poetry:mainfrom
finswimmer:docs-nested-groups

Conversation

@finswimmer
Copy link
Member

@finswimmer finswimmer commented Feb 10, 2025 •
edited by sourcery-ai bot
Loading

Pull Request Check List

Requires: python-poetry/poetry-core#837
Resolves: #7494

Summary by Sourcery

Documentation:

  • Document the include-groups configuration option for grouping and aggregating dependencies across multiple groups

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 10, 2025 •
edited
Loading

Reviewer's Guide

This PR enhances project documentation by introducing a new “Including dependencies from other groups” section in managing-dependencies.md, detailing the include-groups option and illustrating its usage with a TOML example.

Class diagram for dependency group structure with include-groups

classDiagram
    class DependencyGroup {
        +name: str
        +dependencies: list
        +include_groups: list
    }
    class PoetryProject {
        +groups: dict
    }
    PoetryProject "1" -- "*" DependencyGroup : contains
    DependencyGroup <|-- TestGroup
    DependencyGroup <|-- LintGroup
    DependencyGroup <|-- DevGroup
    DevGroup : +include_groups = ["test", "lint"]
    TestGroup : +dependencies = ["pytest"]
    LintGroup : +dependencies = ["ruff"]
    DevGroup : +dependencies = ["tox"]
Loading

File-Level Changes

Change Details Files
Introduce documentation for the include-groups option
  • Added a new subsection header and explanatory text for including dependencies across groups
  • Provided a TOML snippet demonstrating test, lint, and dev groups with include-groups
  • Clarified that the dev group aggregates dependencies from specified groups
 docs/managing-dependencies.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on 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 issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on 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 dismiss on 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 review to 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

@finswimmer finswimmer added the impact/docs Contains or requires documentation changes label Feb 10, 2025
@github-actions
Copy link

github-actions bot commented Feb 10, 2025 •
edited
Loading

Deploy preview for website ready!

✅ Preview
https://website-8xmu2pocf-python-poetry.vercel.app

Built with commit e3858cf.
This pull request is being automatically deployed with vercel-action

@finswimmer finswimmer mentioned this pull request Feb 10, 2025
Merged
2 tasks
@finswimmer finswimmer requested a review from a team February 10, 2025 20:04
@radoering radoering force-pushed the docs-nested-groups branch from faab7c2 to 163b7a8 Compare June 9, 2025 09:19
citelao
citelao approved these changes Jun 10, 2025
View reviewed changes
Copy link

@citelao citelao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered recommending a note about "no cycles", but I think that would be fairly apparent to anyone who starts using include groups.

@radoering radoering force-pushed the docs-nested-groups branch from f12f76f to 8413505 Compare June 29, 2025 07:33
@radoering radoering marked this pull request as ready for review June 29, 2025 15:08
sourcery-ai[bot]
sourcery-ai bot reviewed Jun 29, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @finswimmer - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@radoering radoering enabled auto-merge (squash) June 29, 2025 15:10
@radoering radoering merged commit aeaa3d0 into python-poetry:main Jun 29, 2025
54 checks passed
@github-actions
Copy link

github-actions bot commented Jul 30, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@radoering radoering radoering approved these changes

+1 more reviewer

@citelao citelao citelao approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

impact/docs Contains or requires documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support for hierarchical dependency groups

3 participants

@finswimmer @citelao @radoering