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

panacus: add aarch64/arm64 builds #51066

Closed
wants to merge 2 commits into from

Conversation

martin-g
Copy link
Contributor

@martin-g martin-g commented Oct 1, 2024

Describe your pull request here


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
    • Expanded platform support for the panacus package, now compatible with linux-aarch64 and osx-arm64.
  • Bug Fixes
    • Improved build process with updated installation commands for better reliability.
  • Documentation
    • Updated version and build number in the package metadata.

Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
@martin-g martin-g added aarch64 Related to adding linux-aarch64 support osx-arm64 Related to adding osx-arm64 support labels Oct 1, 2024
Copy link

coderabbitai bot commented Oct 1, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the recipes/panacus package, specifically updating the build.sh script and meta.yaml file. The script now includes debugging options and changes the build process to an installation approach using Cargo. The meta.yaml file updates the build number, adds the Rust compiler to build requirements, and expands platform support while retaining existing runtime dependencies.

Changes

File Change Summary
recipes/panacus/build.sh Added set -xe for debugging; changed build command to cargo install; removed manual binary copy.
recipes/panacus/meta.yaml Updated build number from 0 to 1; added Rust compiler to build requirements; removed specific Rust version; expanded platform support to include linux-aarch64 and osx-arm64.

Possibly related PRs


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.

Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
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: 0

🧹 Outside diff range and nitpick comments (1)
recipes/panacus/build.sh (1)

7-7: Excellent update to the build process.

The switch from cargo build to cargo install with the specified flags (--no-track --locked --verbose) is a significant improvement. It ensures better reproducibility and aligns well with Conda's package management approach. The addition of RUST_BACKTRACE=1 and setting CARGO_HOME are also beneficial for debugging and build consistency.

Consider adding a comment explaining the purpose of the CARGO_HOME setting, as it's not immediately obvious why it's set to "${BUILD_PREFIX}/.cargo". For example:

# Set CARGO_HOME to ensure consistent and isolated dependency management
RUST_BACKTRACE=1 CARGO_HOME="${BUILD_PREFIX}/.cargo" cargo install ...
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8fc154f and 934c377.

📒 Files selected for processing (2)
  • recipes/panacus/build.sh (1 hunks)
  • recipes/panacus/meta.yaml (2 hunks)
🔇 Additional comments (7)
recipes/panacus/build.sh (3)

3-3: Excellent addition for improved debugging and error handling.

The set -xe command enhances the script's robustness by enabling command tracing (-x) and immediate exit on error (-e). This change will make debugging easier and prevent the script from continuing execution after encountering errors, which is crucial for build scripts.


Line range hint 9-10: Appropriate removal of redundant binary copy.

The removal of the command to copy the built binary to $PREFIX/bin is correct, as the cargo install command now handles this step. Retaining the copy command for panacus-visualize.py is also appropriate, as this script is likely not managed by Cargo.


Line range hint 1-10: Verify cross-platform build support for aarch64/arm64.

The changes to the build script improve the overall build process and reproducibility. However, they don't explicitly address the PR objective of adding aarch64/arm64 builds. While the use of cargo install with the --locked flag ensures consistent builds across architectures, additional configuration might be needed to enable cross-platform builds.

To ensure the PR objective is met, please verify that the meta.yaml file includes the necessary configuration for aarch64/arm64 builds. You can use the following script to check the meta.yaml file:

If aarch64/arm64 support is not explicitly mentioned in meta.yaml, consider adding it to the build section or adjusting the skip conditions if necessary.

recipes/panacus/meta.yaml (4)

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

The build number increment from 0 to 1 is correct. This change is necessary when modifying the package build process or expanding platform support without changing the package version.


21-21: LGTM: Addition of Rust compiler is appropriate.

Adding the Rust compiler to the build requirements is necessary for building Rust-based projects. Removing the specific version constraint allows for using the latest available Rust compiler, which is generally a good practice.

Please verify if a minimum Rust version is still required for this package. If so, consider adding it back with an appropriate version constraint.

#!/bin/bash
# Description: Check if there's a minimum Rust version specified in the project

# Test: Search for Rust version requirements in the project files
rg --type rust 'rust-version\s*=\s*"[0-9]+\.[0-9]+(\.[0-9]+)?"' $(fd -e rs -e toml)

Line range hint 1-48: Summary: Changes look good, final checks recommended.

The modifications to the meta.yaml file are appropriate and consistent with the goal of adding aarch64/arm64 builds. The build number has been incremented, the Rust compiler has been added to the build requirements, and the additional platforms have been included.

Before merging, please ensure:

  1. The minimum Rust version requirement has been checked and added if necessary.
  2. Build and test processes have been verified for the new platforms (linux-aarch64 and osx-arm64).
  3. All Bioconda guidelines have been followed, especially regarding the run_exports section mentioned in the PR description.

Run the following script to check if the run_exports section is properly configured:

✅ Verification successful

Run_exports section is properly configured.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if run_exports section is properly configured

# Test: Extract and display the run_exports section
echo "Checking run_exports section in meta.yaml:"
sed -n '/run_exports:/,/^[^ ]/p' recipes/panacus/meta.yaml | sed '$d'

Length of output: 584


46-48: LGTM: Addition of aarch64/arm64 platforms is appropriate.

The addition of 'linux-aarch64' and 'osx-arm64' to the 'additional-platforms' section aligns with the PR objective and increases the accessibility of the package to users with ARM-based systems.

Please ensure that the build and test processes have been verified for these new platforms. Run the following script to check if there are any platform-specific build or test instructions:

@martin-g
Copy link
Contributor Author

martin-g commented Oct 2, 2024

Done with #50991

@martin-g martin-g closed this Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aarch64 Related to adding linux-aarch64 support osx-arm64 Related to adding osx-arm64 support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant