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

Pin gsl to 2.5 for rmats #51411

Merged
merged 2 commits into from
Oct 15, 2024
Merged

Pin gsl to 2.5 for rmats #51411

merged 2 commits into from
Oct 15, 2024

Conversation

npavlovikj
Copy link
Member

Pin gsl to 2.5 for rmats

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 updates to the meta.yaml file for the rmats package, specifically for version 4.3.0. Key modifications include an increase in the build number from 2 to 3. The gsl dependency has been updated to specify version 2.5 in both the host and run requirements, replacing the previous unspecified version. Additionally, the source URL has been reformatted to dynamically include the version number. The file has also been adjusted to ensure a newline at the end of the additional platforms section.

Possibly related PRs

  • updated revision and enabled osx build #51176: This PR updates the meta.yaml file for the pgrc package, which is directly related to the changes made in the main PR that also involves modifications to the meta.yaml file for the same package.

Suggested labels

please review & merge

Suggested reviewers

  • rpetit3

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f6cbfe7 and 2d7c26e.

📒 Files selected for processing (1)
  • recipes/rmats/meta.yaml (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/rmats/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
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 60b837a and f6cbfe7.

📒 Files selected for processing (1)
  • recipes/rmats/meta.yaml (3 hunks)
🧰 Additional context used
🔇 Additional comments (4)
recipes/rmats/meta.yaml (4)

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

Incrementing the build number from 2 to 3 is appropriate when making changes to the recipe without changing the package version. This follows Conda packaging best practices.


29-29: LGTM: GSL version pinning is correct.

Pinning GSL to version 2.5 in both host and run requirements is correct and aligns with the PR objective. This ensures consistency during both build and runtime.

Also applies to: 36-36


Line range hint 1-53: Overall changes align with PR objectives, but some improvements suggested.

The main objective of pinning GSL to version 2.5 for RMATS has been achieved, and the build number has been correctly incremented. However, there are a few points to address:

  1. The run_exports section mentioned in the PR objectives is not present in the changes. Consider adding this to the gsl package recipe as suggested earlier.
  2. The addition of the linux-aarch64 platform, while beneficial, seems unrelated to the main PR objective. Please clarify the reason for including this change in this PR.
  3. Ensure that all changes are necessary and directly related to the PR's main objective of pinning GSL for RMATS.

To verify the impact of these changes, we can check the current and new build configurations:

#!/bin/bash
# Check current RMATS package
conda search rmats --override-channels -c bioconda

# Verify GSL version in current RMATS package
conda list gsl --explicit -n $(conda create -n rmats_test rmats -c bioconda -y | grep -o "rmats_test")

# Clean up
conda env remove -n rmats_test -y

Please review these suggestions and make any necessary adjustments before proceeding.


53-53: LGTM: New platform addition is beneficial, but clarification needed.

Adding support for the linux-aarch64 platform is a positive change that increases the package's compatibility. The addition of a newline at the end of the file is also good practice.

However, this change seems unrelated to the main PR objective of pinning GSL to version 2.5. Could you please clarify the reason for including this change in this PR?

To verify if this platform addition is necessary, we can check if RMATS is already built for linux-aarch64:

@@ -26,14 +26,14 @@ requirements:
- python
- cython
- numpy
- gsl
- gsl=2.5
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding a run_exports section for GSL.

While pinning GSL to version 2.5 is correct, the PR objectives mention adding a run_exports section to prevent potential API, ABI, or CLI breakage issues. Consider adding this section to the gsl package in its recipe, not in the rmats recipe.

Here's an example of how it might look in the gsl package recipe:

build:
  run_exports:
    - {{ pin_subpackage('gsl', max_pin='x.x') }}

This ensures that packages depending on GSL will automatically use the correct version constraints.

@npavlovikj npavlovikj requested a review from acaprez October 15, 2024 23:42
@npavlovikj npavlovikj merged commit 9697ab3 into bioconda:master Oct 15, 2024
7 checks passed
@npavlovikj npavlovikj deleted the update_rmats branch October 15, 2024 23:55
This was referenced Nov 15, 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