Skip to content
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.

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

add expected-files check, rename '--unexpected-file-patterns' to '--expected-files' (fixes #233) #242

Merged
merged 7 commits into from
May 22, 2024

Conversation

jameslamb
Copy link
Owner

@jameslamb jameslamb commented May 22, 2024

Fixes #233.

Adds a new check, [expected-files], which allows the use of pydistcheck to assert that a distribution contains certain files or directories.

For example:

[tool.pydistcheck]
expected_files = [
    # at least one Python source file
    "*.py",
    # 0 static libraries
    "!.a",
    # exactly this specific Jinja2 template
    "coolpkg/resources/templates/the-template.j2"
]

Notes for Reviewers

Calling this breaking because it changes some parameters:

  • --unexpected-directory-patterns to --expected-directories
  • --unexpected-file-patterns to --expected-files

@jameslamb jameslamb added enhancement New feature or request breaking Pull request - breaking change. and removed enhancement New feature or request labels May 22, 2024
@jameslamb jameslamb changed the title add expected-files check (fixes #233) add expected-files check, rename '--unexpected-file-patterns' to '--expected-files' (fixes #233) May 22, 2024
@jameslamb jameslamb merged commit 26b0a20 into main May 22, 2024
21 checks passed
@jameslamb jameslamb deleted the feat/expected-files branch May 22, 2024 03:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Pull request - breaking change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[new check] 'paths_exist'
1 participant