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 PhyloAcc recipe #51090

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Conversation

gwct
Copy link
Contributor

@gwct gwct commented Oct 1, 2024

Changed dependencies to allow for snakemake 8


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

Summary by CodeRabbit

  • New Features
    • Added a new dependency for better integration with SLURM.
  • Updates
    • Updated the version constraint for snakemake-minimal to support newer features.
    • Incremented the build number for the PhyloAcc package.
    • Modified the Python version compatibility condition.
  • Bug Fixes
    • Corrected indentation in the configuration file for improved readability.

Copy link

coderabbitai bot commented Oct 1, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the meta.yaml file for the PhyloAcc package. It modifies the build number, updates the skip condition for Python version compatibility, changes the version constraint for the snakemake-minimal dependency, introduces a new dependency for snakemake-executor-plugin-slurm, and corrects the indentation of the sha256 line in the YAML structure. No other functional changes are made.

Changes

File Path Change Summary
recipes/phyloacc/meta.yaml - Updated build number from 0 to 1.
- Changed skip condition from True # [py < 38] to True # [py < 311].
- Updated snakemake-minimal requirement from >=7.3,<8.0 to >=8.0.
- Added snakemake-executor-plugin-slurm as a new dependency.
- Corrected indentation of sha256 line under source.

Possibly related PRs

  • Update phyloacc to 2.4.0 #50992: This PR updates the meta.yaml file for the PhyloAcc package, which is directly related to the main PR that also modifies the meta.yaml for the same package, albeit with different version and dependency changes.
  • Update phyloacc to 2.4.1 #51082: This PR updates the meta.yaml file for the PhyloAcc package from version 2.4.0 to 2.4.1, which is closely related to the main PR that updates the build number and dependencies for the same package.

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 47eec93 and 4b8f441.

📒 Files selected for processing (1)
  • recipes/phyloacc/meta.yaml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/phyloacc/meta.yaml

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

@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: 1

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

38-38: Consider adding an upper bound to the Snakemake version requirement.

The update to snakemake-minimal >=8.0 aligns with the PR objective to ensure compatibility with Snakemake version 8. However, removing the upper bound constraint might lead to potential compatibility issues with future major versions of Snakemake.

Consider adding an upper bound to prevent potential issues with future major versions:

-    - snakemake-minimal >=8.0
+    - snakemake-minimal >=8.0,<9.0

This ensures compatibility with Snakemake 8.x versions while preventing potential issues with Snakemake 9.0 and beyond.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 65005c7 and 47eec93.

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

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

Incrementing the build number from 0 to 1 is appropriate when updating the recipe without changing the package version. This change follows Conda packaging best practices.


Line range hint 1-67: Summary of changes and recommendations

The changes to the PhyloAcc recipe align with the PR objectives to ensure compatibility with Snakemake version 8. Here's a summary of the review:

  1. The build number increment is correct and follows best practices.
  2. The Snakemake version requirement has been updated, but consider adding an upper bound to prevent potential issues with future major versions.
  3. A new dependency for SLURM execution has been added. Please clarify if this is necessary for all users and consider adding a version constraint.

Overall, the changes look good, but addressing the suggestions above would further improve the recipe's robustness and maintainability.

@@ -35,7 +35,8 @@ requirements:
- matplotlib-base >=3.5
- biopython >=1.79
- numpy >=1.22
- snakemake-minimal >=7.3,<8.0
- snakemake-minimal >=8.0
- snakemake-executor-plugin-slurm
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

🛠️ Refactor suggestion

Add version constraints to the snakemake-executor-plugin-slurm dependency.

The addition of snakemake-executor-plugin-slurm in recipes/phyloacc/meta.yaml is necessary for SLURM support. To ensure compatibility and prevent potential issues in the future, it's recommended to specify version constraints for this dependency. This approach aligns with how other executor plugins are managed in the codebase.

  • Example:

    -    - snakemake-executor-plugin-slurm
    +    - snakemake-executor-plugin-slurm >=0.2.0,<1.0.0

    Replace 0.2.0 with the minimum required version that is compatible with PhyloAcc.

🔗 Analysis chain

Clarify the necessity of the new SLURM plugin dependency and consider adding a version constraint.

The addition of snakemake-executor-plugin-slurm suggests that PhyloAcc now supports SLURM execution through Snakemake. However, there are a few points to consider:

  1. Is this plugin necessary for all users, or should it be an optional dependency?
  2. The version of this new dependency is not specified, which could lead to potential compatibility issues in the future.

To better understand the usage of this plugin in the PhyloAcc codebase, let's run the following script:

If the plugin is indeed necessary, consider adding a version constraint to ensure compatibility:

-    - snakemake-executor-plugin-slurm
+    - snakemake-executor-plugin-slurm >=0.1.0,<1.0.0

Replace 0.1.0 with the minimum required version that works with PhyloAcc.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for usage of SLURM-related configurations or the new plugin in the PhyloAcc codebase

# Test: Search for SLURM-related configurations or mentions of the new plugin
rg --type python -i '(slurm|snakemake.*executor.*plugin)'

Length of output: 90


Script:

#!/bin/bash
# Description: Search for usage of SLURM-related configurations or the new plugin in the PhyloAcc codebase

# Test: Search for SLURM-related configurations or mentions of the new plugin across all relevant file types
rg -i '(slurm|snakemake.*executor.*plugin)'

Length of output: 10311

@gwct
Copy link
Contributor Author

gwct commented Oct 2, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 2, 2024
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