Skip to content

Documentation: Clarified negating VCS excluded files #10442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
radoering merged 1 commit into from
Jun 28, 2025
Merged

Documentation: Clarified negating VCS excluded files #10442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/pyproject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,12 +645,6 @@ You can explicitly specify to Poetry that a set of globs should be ignored or in
The globs specified in the exclude field identify a set of files that are not included when a package is built.
`include` has priority over `exclude`.

If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (`.gitignore` for git, for example).

{{% note %}}
Explicitly declaring entries in `include` will negate VCS' ignore settings.
{{% /note %}}

You can also specify the formats for which these patterns have to be included, as shown here:

```toml
Expand All @@ -672,6 +666,11 @@ Pay attention to include top level files and directories with common names like
`CHANGELOG.md`, `LICENSE`, `tests` or `docs` only in sdists and **not** in wheels.
{{% /warning %}}

If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (`.gitignore` for git, for example).

{{% note %}}
VCS ignore settings can be negated by adding entries in `include`; be sure to explicitly set the `format` as above.
{{% /note %}}

### dependencies and dependency groups

Expand Down