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

pydustmasker: add aarch64 build #51158

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

martin-g
Copy link
Contributor

@martin-g martin-g commented Oct 4, 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>.

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 4, 2024
Copy link

coderabbitai bot commented Oct 4, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the build.sh script and the meta.yaml file for the pydustmasker package. The build.sh script now includes additional environment variable exports for linker settings tailored to AArch64 and ARM64 architectures on Linux and macOS. The meta.yaml file has been updated to set the package version to "1.0.0", increment the build number, correct indentation issues, and add an extra section specifying additional platforms.

Changes

File Change Summary
recipes/pydustmasker/build.sh Added exports for linkers: CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER, CARGO_TARGET_AARCH64_APPLE_DARWIN_GNU_LINKER, CARGO_TARGET_ARM64_APPLE_DARWIN_GNU_LINKER.
recipes/pydustmasker/meta.yaml Updated version to "1.0.0", incremented build number from 0 to 1, corrected indentation, and added extra.additional-platforms: linux-aarch64, osx-arm64.

Possibly related PRs

Suggested reviewers

  • mencian

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between aca5bd9 and 67cabf1.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 625280e and aca5bd9.

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

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

The build number has been correctly incremented from 0 to 1. This is the right approach when making changes to a package without altering its version, which aligns with the PR objective of adding aarch64/arm64 builds.


Line range hint 1-41: Summary: Changes align well with PR objectives.

The modifications to this meta.yaml file are consistent with the PR's goal of adding aarch64/arm64 builds for the pydustmasker package:

  1. The build number has been incremented (line 13).
  2. An extra section has been added to specify additional platforms (lines 38-41).

These changes are appropriate and sufficient for enabling builds for the new architectures. The rest of the file, including version, source, requirements, test, and about sections, remains unchanged, which is correct for this type of update.


38-41: LGTM: Additional platforms correctly specified.

The extra section has been added correctly, specifying the additional platforms (linux-aarch64 and osx-arm64) for the build. This change directly addresses the PR objective of adding aarch64/arm64 builds to the pydustmasker package.

To ensure the correctness of the added platforms, let's verify if these are standard platform identifiers used in Conda:

✅ Verification successful

Verified: Added platforms are standard in Conda recipes.

The platforms linux-aarch64 and osx-arm64 are consistently used across multiple recipes, confirming their standard usage in Conda.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify if the added platform identifiers are standard in Conda

# Test: Search for usage of these platform identifiers in other recipe files
# Expect: Multiple occurrences of these identifiers in other recipes
rg --type yaml 'linux-aarch64|osx-arm64' recipes/

Length of output: 59383

Comment on lines 14 to 16
export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER="$CC"
export CARGO_TARGET_AARCH64_APPLE_DARWIN_GNU_LINKER="$CC"
export CARGO_TARGET_ARM64_APPLE_DARWIN_GNU_LINKER="$CC"
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

Remove unnecessary ARM64 export statements

The build environment is currently configured for x86_64 on Linux, and ARM64 builds are not being performed. Therefore, the ARM64 export statements in recipes/pydustmasker/build.sh are unnecessary and can be removed to streamline the configuration.

🔗 Analysis chain

Adjust export statements for comprehensive architecture support

The added export statements are a good step towards supporting aarch64/arm64 builds. However, there are a couple of adjustments that could improve the configuration:

  1. Add support for ARM64 on Linux:
    The current configuration doesn't include an export for ARM64 on Linux, which might be necessary for complete architecture support.

  2. Simplify macOS configuration:
    On macOS, AArch64 and ARM64 are synonymous, so having separate exports for both might be redundant.

Consider applying the following changes:

 export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER="$CC"
+export CARGO_TARGET_ARM64_UNKNOWN_LINUX_GNU_LINKER="$CC"
 export CARGO_TARGET_AARCH64_APPLE_DARWIN_GNU_LINKER="$CC"
-export CARGO_TARGET_ARM64_APPLE_DARWIN_GNU_LINKER="$CC"

This modification ensures support for both AArch64 and ARM64 on Linux while simplifying the macOS configuration.

To verify the necessity of these changes, you can run the following script:

This script will help determine if the package is being built for different architectures and operating systems, which can guide the decision on which export statements are necessary.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the package is being built for different architectures

# Test: Check if the package is being built for ARM64 on Linux
if [[ "$(uname -m)" == "aarch64" && "$(uname -s)" == "Linux" ]]; then
  echo "Building for ARM64 on Linux"
  # Add your ARM64 Linux-specific build commands here
fi

# Test: Check if the package is being built for ARM64 on macOS
if [[ "$(uname -m)" == "arm64" && "$(uname -s)" == "Darwin" ]]; then
  echo "Building for ARM64 on macOS"
  # Add your ARM64 macOS-specific build commands here
fi

# Output the current architecture and OS for reference
echo "Current architecture: $(uname -m)"
echo "Current OS: $(uname -s)"

Length of output: 221

@martin-g martin-g changed the title pydustmasker: add aarch64/arm64 builds pydustmasker: add aarch64 build Oct 5, 2024
@martin-g martin-g removed the osx-arm64 Related to adding osx-arm64 support label Oct 5, 2024
@martin-g
Copy link
Contributor Author

martin-g commented Oct 5, 2024

@BiocondaBot please fetch artifacts

@BiocondaBot
Copy link
Collaborator

Package(s) built are ready for inspection:

Arch Package Zip File / Repodata CI Instructions
linux-64 pydustmasker-1.0.0-py310h7c593f9_1.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
linux-64 pydustmasker-1.0.0-py311hdad781d_1.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
linux-64 pydustmasker-1.0.0-py312hf67a6ed_1.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
linux-64 pydustmasker-1.0.0-py38h0020b31_1.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
linux-64 pydustmasker-1.0.0-py39hff71179_1.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
osx-64 pydustmasker-1.0.0-py310h341b679_1.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
osx-64 pydustmasker-1.0.0-py311hb338bc1_1.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
osx-64 pydustmasker-1.0.0-py312h68c8633_1.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
osx-64 pydustmasker-1.0.0-py38h51c4a30_1.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
osx-64 pydustmasker-1.0.0-py39h1841df5_1.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
linux-aarch64 pydustmasker-1.0.0-py310h8c4ab44_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c11471b6-f41f-45b1-9784-51d12e104fbe/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 pydustmasker-1.0.0-py311h9d58220_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c11471b6-f41f-45b1-9784-51d12e104fbe/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 pydustmasker-1.0.0-py312hcf8b9e2_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c11471b6-f41f-45b1-9784-51d12e104fbe/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 pydustmasker-1.0.0-py38h7763450_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c11471b6-f41f-45b1-9784-51d12e104fbe/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 pydustmasker-1.0.0-py39hf354171_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c11471b6-f41f-45b1-9784-51d12e104fbe/artifacts/0/tmp/artifacts/packages <package name>

Docker image(s) built:

Package Tag CI Install with docker
pydustmasker 1.0.0--py310h7c593f9_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/pydustmasker:1.0.0--py310h7c593f9_1.tar.gz | docker load
pydustmasker 1.0.0--py311hdad781d_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/pydustmasker:1.0.0--py311hdad781d_1.tar.gz | docker load
pydustmasker 1.0.0--py312hf67a6ed_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/pydustmasker:1.0.0--py312hf67a6ed_1.tar.gz | docker load
pydustmasker 1.0.0--py38h0020b31_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/pydustmasker:1.0.0--py38h0020b31_1.tar.gz | docker load
pydustmasker 1.0.0--py39hff71179_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/pydustmasker:1.0.0--py39hff71179_1.tar.gz | docker load

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants