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

Update decom recipe by adding kmtricks dependency #51911

Merged
merged 6 commits into from
Nov 5, 2024

Conversation

CamilaDuitama
Copy link
Contributor

@CamilaDuitama CamilaDuitama commented Nov 4, 2024

EDIT to decom recipe


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the meta.yaml file for the decOM package. The build number is incremented from 1 to 2, and the noarch attribute is specified as python. The build requirements section is modified to replace the previous python >=3.6 entry with python >=3.9,<3.13, while setuptools remains included. The run requirements section is similarly updated to reflect the new version constraints for python, changing from python >=3.6 to python >=3.9,<3.13. Additionally, the numpy requirement is updated from unspecified to numpy >=1.7, and a new requirement for kmtricks >=1.4.0 is added. The overall structure of the requirements section is adjusted accordingly, while the entry points and test commands remain unchanged.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • bgruening

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

Copy link
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

🧹 Outside diff range and nitpick comments (1)
recipes/decom/meta.yaml (1)

Line range hint 1-71: Consider updating package documentation.

The package has undergone significant changes:

  1. Moved from pure Python (noarch) to compiled code
  2. Added new dependencies
  3. Added run_exports pinning

Consider:

  1. Updating the package documentation to reflect build requirements
  2. Adding build instructions to the README
  3. Documenting system requirements for end users
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f15d991 and 3d7b151.

📒 Files selected for processing (1)
  • recipes/decom/meta.yaml (3 hunks)
🔇 Additional comments (3)
recipes/decom/meta.yaml (3)

15-15: LGTM: Build number increment is appropriate.

The build number increment is correct as dependencies have been modified.


43-44: Verify kmtricks version compatibility.

The addition of zlib and kmtricks as runtime dependencies needs verification:

  1. Is kmtricks >=1.4.0 the minimum compatible version?
  2. Are there any known compatibility issues with newer versions?
#!/bin/bash
# Check if kmtricks is available in bioconda
conda search -c bioconda kmtricks --info

# Look for version requirements in source code
rg -l "kmtricks" 

26-29: Verify build requirements against upstream.

The addition of C++ compiler and build tools suggests this package now includes compiled components. This is a significant change from being a noarch package.

Consider documenting the reason for this architectural change in the PR description.

@CamilaDuitama CamilaDuitama changed the title Add kmtricks dependency to decom recipe Update decom recipe by adding kmtricks dependency Nov 4, 2024
Copy link
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

🧹 Outside diff range and nitpick comments (2)
recipes/decom/meta.yaml (2)

35-35: Consider updating numpy version constraint.

The numpy version constraint >=1.7 is quite old. Consider setting a more recent minimum version to ensure compatibility with modern features and security updates.


75-75: Add newline at end of file.

Add a newline character at the end of the file to comply with YAML formatting standards.

-    - CamilaDuitama
+    - CamilaDuitama
+
🧰 Tools
🪛 yamllint

[error] 75-75: no new line character at the end of file

(new-line-at-end-of-file)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2428486 and 2faf8d8.

📒 Files selected for processing (1)
  • recipes/decom/meta.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint
recipes/decom/meta.yaml

[error] 75-75: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (3)
recipes/decom/meta.yaml (3)

14-14: LGTM: Build number increment is appropriate.

The build number increment is correct as dependencies were modified.


42-42: LGTM: kmtricks dependency added as per PR objective.

The addition of kmtricks >=1.4.0 aligns with the PR's purpose and follows Bioconda's versioning guidelines.


30-32: Verify Python version constraints with kmtricks compatibility.

The Python version constraint has been tightened significantly. Let's verify this aligns with kmtricks requirements.

✅ Verification successful

Let me check kmtricks' Python requirements to ensure alignment.


Let me try one more search to specifically look for kmtricks' requirements:


Python version constraints are appropriate

The Python version constraints (>=3.9,<3.13) are well-aligned with the package requirements:

  • kmtricks is used as a dependency (>=1.4.0) without specific Python constraints
  • The upper bound <3.13 is a good practice to prevent untested Python versions
  • The lower bound >=3.9 is reasonable for a modern scientific package
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check kmtricks recipe for Python version requirements
fd -t f "meta.yaml" -x grep -l "kmtricks" {} \; | xargs cat | grep -A 5 "python"

Length of output: 477


Script:

#!/bin/bash
# Check kmtricks package for Python version constraints
fd -t f "meta.yaml" -x grep -l "kmtricks" {} \; -exec dirname {} \; | xargs -I {} find {} -type f -name "meta.yaml" | xargs cat | grep -A 5 "python"

# Also check setup.py/pyproject.toml for any Python version specifications
fd -t f "setup.py|pyproject.toml" | xargs cat | grep -A 5 "python"

Length of output: 2164


Script:

#!/bin/bash
# Search for kmtricks package requirements
rg -A 5 "kmtricks" --type yaml

# Also check if there's any kmtricks documentation or README
fd -t f "README|INSTALL" -e md -e txt | xargs cat | grep -A 5 -B 5 "python"

Length of output: 1963

@CamilaDuitama
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 4, 2024
Copy link
Contributor

@mencian mencian left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @CamilaDuitama!

@mencian mencian merged commit 2d22746 into bioconda:master Nov 5, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants