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 Snippy: restrict samtools to version <=1.20 #51628

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

pmenzel
Copy link
Contributor

@pmenzel pmenzel commented Oct 24, 2024

this is a workaround to make snippy work again.

samtools should be version <= 1.20, as Snippy fails to run with samtools v1.21, see tseemann/snippy#598


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>.

restrict samtools to version <= 1.20, as Snippy fails to run with samtools v1.21, see tseemann/snippy#598
@pmenzel
Copy link
Contributor Author

pmenzel commented Oct 24, 2024

please review @rpetit3

Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

📝 Walkthrough

Walkthrough

The pull request involves modifications to the meta.yaml file for the snippy package. The primary change is the update of the package version from 4.6.0 to 5, indicating a new build iteration. The sha256 hash remains unchanged. Additionally, the requirements section has been updated to restrict the version of samtools from >=1.10 to >=1.10,<=1.20, which limits the acceptable versions to a specific range. This alteration aims to address compatibility issues with later versions of samtools. The overall structure of the meta.yaml file, including sections for build, test, about, and extra, remains unchanged.

Possibly related PRs

Suggested labels

please review & merge


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 11ec7d5 and aae1bbb.

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

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

The build number increment is correct as it reflects the dependency constraint update.


25-25: LGTM: Samtools version constraint addresses known compatibility issues.

The addition of <=1.20 constraint for samtools is well-justified:

  • Prevents issues with samtools v1.21 as documented in Snippy's GitHub issues
  • Follows Bioconda's best practices for dependency version pinning
  • Consistent with other carefully pinned dependencies in the recipe (e.g., vcflib, snpeff)

Let's verify if any other recipes depend on snippy and might be affected:

✅ Verification successful

Let me analyze the output. The search found several recipes that depend on snippy, but I need to check if they specifically depend on the samtools version constraint. Let me generate scripts to check this.


Based on the search results, I can now provide a final response:

Verified: The samtools version constraint is safe and properly managed across dependencies.

The version constraint samtools >=1.10,<=1.20 in snippy is compatible with its dependent packages. The only other package showing a samtools dependency is nullarbor, which requires samtools >=1.9, making it fully compatible with snippy's constraint.

The version pinning appears well-considered as:

  • It maintains compatibility with nullarbor's requirement
  • Other key dependencies in snippy are also carefully version-constrained (e.g., vcflib, snpeff) to prevent known issues
  • The upper bound helps prevent potential compatibility issues with future samtools versions
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for recipes that depend on snippy
rg -l "(?i)snippy.*\d" recipes/*/meta.yaml

Length of output: 320876


Script:

#!/bin/bash
# Check the dependencies section in the found recipes for samtools version constraints
rg -A 10 -B 10 "samtools" recipes/snippy/meta.yaml recipes/pgcgap/meta.yaml recipes/pathogist/meta.yaml recipes/nullarbor/meta.yaml recipes/bactopia-variants/meta.yaml recipes/agrvate/meta.yaml

Length of output: 2263


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.

@martin-g martin-g merged commit e0997be into bioconda:master Oct 24, 2024
7 checks passed
This was referenced Nov 1, 2024
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