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

parsnp: add aarch64/arm64 builds #51064

Open
wants to merge 1 commit into
base: master
Choose a base branch
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

    • Enhanced build script for improved functionality and robustness.
    • Added support for additional platforms: linux-aarch64 and osx-arm64.
  • Bug Fixes

    • Updated build process to ensure necessary directories are created and cleaned up after installation.
  • Documentation

    • Version updated in the meta.yaml file to reflect changes.
    • Updated dependency for Linux from openmp to libgomp.

@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

Walkthrough

The pull request introduces modifications to the build.sh script and the meta.yaml file for the parsnp package. The build.sh script enhancements include improved error handling, directory structure management, and consistent compilation flags across platforms. The meta.yaml file reflects a version number increment and the addition of new platforms in the extra section, while maintaining existing requirements and documentation links.

Changes

File Change Summary
recipes/parsnp/build.sh Added set -xe for debugging; created $PREFIX/bin directory structure; updated CXXFLAGS for muscle; used ${CPU_COUNT} for parallel builds; cleaned up post-installation files; copied necessary application files to $PREFIX/bin.
recipes/parsnp/meta.yaml Updated build number from 0 to 1; adjusted source URL; changed Linux dependency from openmp to libgomp; added platforms linux-aarch64 and osx-arm64 in the extra section.

Possibly related PRs

  • pgrc: add linux-aarch64 build #51009: The changes in the main PR regarding the build.sh script and the use of ${CPU_COUNT} for parallel builds are relevant to the modifications made in the build.sh of the pgrc package, which also involves setting up a build environment and optimizing the build process.
  • recipe for pgrc #50973: The build.sh script for pgrc introduces a similar structure for creating a binary directory under $PREFIX/bin, which aligns with the changes made in the main PR to ensure proper directory creation for the parsnp application.

Suggested reviewers

  • apeltzer

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8cbcafe and b7c9d65.

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

🧹 Outside diff range and nitpick comments (2)
recipes/parsnp/build.sh (2)

18-18: Improved build efficiency with parallel compilation.

Using ${CPU_COUNT} for parallel builds is an excellent optimization. This change can significantly speed up the compilation process on multi-core systems.

Consider adding a fallback in case ${CPU_COUNT} is not set:

-make -j ${CPU_COUNT}
+make -j ${CPU_COUNT:-1}

This ensures the build works even if ${CPU_COUNT} is not defined, defaulting to a single core.


29-29: Consistent parallel build optimization for main application.

Excellent addition of parallel compilation for the main application build, consistent with the muscle library build optimization.

As suggested earlier, consider adding a fallback for ${CPU_COUNT}:

-make -j ${CPU_COUNT} LDADD="$LDADD -lMUSCLE-3.7"
+make -j ${CPU_COUNT:-1} LDADD="$LDADD -lMUSCLE-3.7"

This ensures the build works even if ${CPU_COUNT} is not defined, defaulting to a single core.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

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

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

3-4: Improved script robustness and debugging.

The addition of set -xe is a good practice. It enables command echoing (-x) for easier debugging and ensures the script exits immediately if any command fails (-e), preventing cascading errors.


Line range hint 35-43: Comprehensive file installation.

Good job ensuring all necessary files are copied to the installation directory. This includes the main executable, Python scripts, and additional resources.

The creation of a $PREFIX/bin/bin directory is unusual. Please verify if this structure is intentional and required for the package to function correctly. Run the following script to check the final directory structure:

Review the output to ensure the directory structure is correct and all files are in their intended locations.


Line range hint 31-33: Cleanup of build artifacts.

Good practice to remove unnecessary directories after installation, helping to keep the package size minimal.

Please verify that removing these directories doesn't impact the package functionality. Run the following script to check for any remaining references to these directories:

If the script returns any results, we may need to adjust the cleanup or update other parts of the package.

✅ Verification successful

Cleanup Verification Successful

The removal of the directories muscle/libMUSCLE, muscle/autom4te.cache, and muscle/m4 does not impact the package functionality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining references to removed directories

# Test: Search for references to removed directories
rg -i 'muscle/libMUSCLE|muscle/autom4te.cache|muscle/m4' --type sh --type yaml

Length of output: 219

recipes/parsnp/meta.yaml (3)

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

Incrementing the build number from 0 to 1 is appropriate when making changes to the package without altering the version. This change aligns with the PR objective of adding new architecture builds.


Line range hint 1-48: Verify architecture-specific requirements for new platforms.

The package version, source URL, and general requirements appear correct. However, given the addition of 'linux-aarch64' and 'osx-arm64' platforms, it's important to verify if any architecture-specific requirements or build flags are needed.

Could you confirm if any additional requirements or build flags are necessary for the 'linux-aarch64' and 'osx-arm64' architectures? This might include architecture-specific compiler flags or dependencies.

To assist in this verification, let's check for any existing architecture-specific patterns in the recipe:

#!/bin/bash
# Description: Check for architecture-specific patterns in the recipe

# Test: Search for architecture-specific selectors or flags
rg --type yaml '\[aarch64\]|\[arm64\]|\[osx-arm64\]' recipes/parsnp/meta.yaml

50-53: Clarification needed on 'additional-platforms' usage.

The addition of 'linux-aarch64' and 'osx-arm64' platforms aligns with the PR objective. However, 'additional-platforms' is not a standard Conda recipe field.

Could you clarify the purpose and effect of using 'additional-platforms' in the 'extra' section? Is this a Bioconda-specific feature?

To verify if this is a common practice in Bioconda recipes, let's run the following script:

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