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 Crabs #51394

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update Crabs #51394

wants to merge 2 commits into from

Conversation

famosab
Copy link

@famosab famosab commented Oct 15, 2024

Related to: gjeunen/reference_database_creator#66
Also includes changes from: #35250 (partly)


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 Oct 15, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces several modifications to the meta.yaml file for the "crabs" package. Key changes include updating the package version from "0.1.1" to "1.0.3" and implementing Jinja2 templating for dynamic assignment of the package name and version. The source URL has been revised to incorporate the version variable instead of linking to a specific file. Additionally, a SHA256 checksum has been added for the source tarball. The build script has been modified to include the --no-deps flag and to increase verbosity. Significant alterations have been made to the requirements section, where several dependencies have been commented out in the build section, indicating they are no longer necessary. The host requirements have been updated to specify versions for wget and muscle, which are also included in the run requirements. A new entry for run_exports has been added to manage subpackage dependencies. These changes collectively enhance the package's versioning, source management, and dependency specifications.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • mencian
  • gbayarri

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/crabs/meta.yaml (1)

37-38: LGTM! Consider documenting version constraints.

The addition of specific versions for wget and muscle in the run requirements is good for ensuring reproducibility.

It might be helpful to add a comment explaining why these specific versions are required. This can aid future maintenance and upgrades of the package.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9b25c3e and fe65111.

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

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (5)
recipes/crabs/meta.yaml (5)

1-7: LGTM! Consider documenting the significant version bump.

The use of Jinja2 templating for package name and version is a good practice. The addition of the SHA256 checksum enhances security. However, the version bump from 0.1.1 to 1.0.3 seems significant.

Could you please verify if this version bump aligns with the upstream changes? If there are breaking changes, consider documenting them in the package description or README.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


10-11: LGTM! Improved source URL and added checksum.

The updated source URL using the version variable is more maintainable. The inclusion of the SHA256 checksum enhances security and integrity verification.


15-15: LGTM! Improved build script configuration.

The addition of the --no-deps flag is appropriate for Conda recipes, as it prevents pip from installing dependencies (which should be managed by Conda). The increased verbosity (-vvv) can be helpful for troubleshooting installation issues if they arise.


22-28: Please clarify the status of commented-out host dependencies.

Several dependencies in the host section have been commented out. If these are no longer needed for building the package, it would be cleaner to remove them entirely rather than leaving them commented. If they are still necessary, they should be uncommented.

Could you please clarify the reasoning behind commenting out these dependencies? If they are truly not needed, consider removing them completely for better maintainability.


1-3: Note on static analysis warning.

The static analysis tool (yamllint) reported a syntax error for the '%' character at the beginning of the file. This is a false positive. The '%' character is valid in this context as it's part of the Jinja2 templating syntax used in Conda recipes.

No action is needed to address this warning.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

@@ -33,8 +36,8 @@ requirements:
- numpy
- pandas >=0.23.4
- matplotlib-base
- wget
- muscle >=3.8.31
- wget =1.21.3
Copy link
Contributor

Choose a reason for hiding this comment

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

Why exactly 1.21.3 ?

Copy link
Author

Choose a reason for hiding this comment

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

not sure - just copied that from the other PR. I think we can go for the latest version here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I guess any new semver compatible version should be OK.
Pinning with exact versions is usually not recommended.

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/crabs/meta.yaml (1)

15-18: Consider adjusting the run_exports section

The build script changes look good:

  • Adding --no-deps ensures stricter control over dependencies.
  • Increased verbosity (-vvv) can help with debugging.

However, for the run_exports section, consider the following suggestion from a previous review:

noarch: python
run_exports:
  - {{ pin_subpackage(name, max_pin="x.x") }}

This change would make the noarch: python declaration part of the build section and adjust the indentation of run_exports.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fe65111 and e791e92.

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

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (5)
recipes/crabs/meta.yaml (5)

1-7: LGTM: Improved package metadata with Jinja2 templating

The introduction of Jinja2 variables for name, version, and sha256 enhances maintainability. The package version update to 1.0.3 aligns with the PR objectives, and the dynamic package name ensures consistency.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


10-11: LGTM: Improved source specification

The source URL now dynamically incorporates the version, facilitating easier future updates. The addition of the SHA256 checksum enhances the security and integrity of the package source.


24-30: Verify the removal of host requirements

Several dependencies have been commented out in the host requirements section. Could you please confirm if these dependencies are no longer needed for building the package? If they're truly not required, consider removing the commented lines entirely for cleaner code.


39-40: LGTM: Improved version pinning for run requirements

The addition of specific versions for wget and muscle in the run requirements is a good practice. This helps ensure reproducibility and aligns with best practices for dependency management in Conda recipes.


1-1: Note on yamllint warning

The yamllint tool reports a syntax error for the '%' character. This is a false positive as the '%' is part of valid Jinja2 syntax, which is supported in Conda meta.yaml files. We can safely ignore this warning.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

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