Skip to content

feat: MANIFEST.in: include tests/ in sdist#3073

Merged
johanneskoester merged 1 commit intosnakemake:mainfrom
veprbl:patch-2
Sep 7, 2024
Merged

feat: MANIFEST.in: include tests/ in sdist#3073
johanneskoester merged 1 commit intosnakemake:mainfrom
veprbl:patch-2

Conversation

@veprbl
Copy link
Copy Markdown
Contributor

@veprbl veprbl commented Sep 5, 2024

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

  • Chores
    • Updated the packaging configuration to include all test files in the source distribution, enhancing the completeness of the package for users.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Sep 5, 2024

Walkthrough

The changes to the MANIFEST.in file include the addition of a graft tests directive, which ensures that the entire tests directory is included in the source distribution. This update allows all test files within the directory to be packaged, rather than just a subset defined by default patterns.

Changes

File Change Summary
MANIFEST.in Added graft tests to include all test files in the tests directory in the source distribution.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@veprbl veprbl changed the title MANIFEST.in: include tests/ in sdist feat: MANIFEST.in: include tests/ in sdist Sep 5, 2024
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Sep 5, 2024

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ec61f4 and f7b8bd4.

Files selected for processing (1)
  • MANIFEST.in (1 hunks)
Additional comments not posted (2)
MANIFEST.in (2)

4-6: Approved: Inclusion of tests/ directory in sdist.

The addition of graft tests is correctly implemented to include the entire tests/ directory in the source distribution. This change ensures that all test files are available to users, which is beneficial for verifying the package's functionality.


4-6: Verify PR checklist completion.

Ensure that the PR checklist items are addressed:

  1. Confirm that the PR contains a test case for the changes made or that existing test cases already cover the changes.
  2. Ensure that the documentation in the docs/ directory is updated to reflect any changes made, or confirm that no updates are necessary if the changes do not affect the language, behavior, or functionalities of Snakemake.

@johanneskoester johanneskoester merged commit e24f3fc into snakemake:main Sep 7, 2024
johanneskoester pushed a commit that referenced this pull request Sep 7, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.20.0](v8.19.3...v8.20.0)
(2024-09-07)


### Features

* allow skipping apptainer and conda tests if not available
([#3074](#3074))
([c3cd4e0](c3cd4e0))
* MANIFEST.in: include tests/ in sdist
([#3073](#3073))
([e24f3fc](e24f3fc))


### Bug Fixes

* add subfolders of report template to package data
([14a8f22](14a8f22))
* Inconsistent Linting Output Formatting
([#3064](#3064))
([90e51ae](90e51ae))
* retry when downloading assets
([58e41b0](58e41b0))
* skip asset download if files are already present
([#3076](#3076))
([0d3d1e1](0d3d1e1))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants