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

tidk: add aarch64/arm64 builds #51159

Merged
merged 1 commit into from
Oct 4, 2024
Merged

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

Summary by CodeRabbit

  • New Features
    • Added support for additional platforms: linux-aarch64 and osx-arm64.
  • Version Updates
    • Updated package version to 0.2.63.
    • Incremented build number from 0 to 1.

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
Contributor

coderabbitai bot commented Oct 4, 2024

📝 Walkthrough

Walkthrough

The pull request includes modifications to two files: build.sh and meta.yaml for the tidk package. The build.sh script's shebang line has been changed, and the set -xe command has been added, along with an update to the cargo install command to include the --no-track option. The meta.yaml file has been updated to reflect a new version number, an incremented build number, and the addition of support for two new platforms: linux-aarch64 and osx-arm64.

Changes

File Change Summary
recipes/tidk/build.sh Changed shebang from #!/bin/bash -e to #!/bin/bash, added set -xe, updated cargo install with --no-track.
recipes/tidk/meta.yaml Version updated to "0.2.63", build number incremented to 1, added additional-platforms for linux-aarch64 and osx-arm64.

Possibly related PRs

Suggested reviewers

  • bgruening: Suggested reviewer for the changes made in this pull request.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

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

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

1-1: LGTM: Shebang line modification improves flexibility.

The removal of the -e option from the shebang line is a good change. It allows for more granular control over error handling within the script. This modification is compensated by the addition of set -xe on line 3, which re-enables immediate exit on error along with verbose output.


3-3: Excellent addition: Enhanced debugging and error handling.

The addition of set -xe is a great improvement to the script. It serves two important purposes:

  1. The -x option enables verbose output, printing each command before execution. This significantly aids in debugging and understanding the script's flow.
  2. The -e option ensures the script exits immediately if any command fails, maintaining the strict error handling that was previously set in the shebang line.

This change will make the build process more transparent and easier to troubleshoot if issues arise.


6-6: Please clarify the use of --no-track option.

The addition of the --no-track option to the cargo install command is noteworthy. This option prevents Cargo from tracking which files are installed by this package. While this might be intentional, it's important to understand the reasoning behind this change and its potential implications for package management within the Bioconda ecosystem.

Could you please provide more context on:

  1. Why was the --no-track option added?
  2. How does this align with Bioconda's package management practices?
  3. Are there any potential drawbacks or benefits to using this option in this context?

To help assess the impact of this change, let's check if other Rust-based recipes in Bioconda use this option:

This will help us understand if this is a common practice or a unique case for the tidk package.

✅ Verification successful

--no-track Option Usage Verified

The --no-track option is consistently used across multiple Rust-based recipes within the Bioconda repository, including recipes/tidk/build.sh. This confirms that its inclusion aligns with Bioconda's established package management practices.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other Rust-based recipes using cargo install
rg --type sh 'cargo install' recipes

Length of output: 12192

recipes/tidk/meta.yaml (4)

8-10: Build number increment looks good

The build number has been correctly incremented to 1. The presence of the run_exports section is also good for maintaining ABI compatibility across minor version updates.


Line range hint 1-42: Overall changes look good

The changes in this PR are minimal and focused:

  1. Version update to 0.2.63
  2. Build number increment to 1
  3. Addition of linux-aarch64 and osx-arm64 platforms

These changes align with the PR objectives and follow Bioconda guidelines. The rest of the recipe remains unchanged, which is appropriate as no other modifications seem necessary for the new platforms.

Please ensure that all verification steps mentioned in previous comments are completed successfully before merging this PR.


Line range hint 1-1: Verify version update and related changes

The version has been updated to "0.2.63". This change looks good, but please ensure that the source URL and SHA256 hash (lines 14-15) have also been updated to match this new version.


39-42: Additional platforms look good, verify build success

The addition of linux-aarch64 and osx-arm64 platforms is in line with the PR objectives. This change looks good and is correctly placed in the extra section.

To ensure that the package builds successfully on these new platforms, please verify the build logs or artifacts for linux-aarch64 and osx-arm64. You can use the following command to check if the builds were successful:

If the builds were successful, you should see output indicating that the packages were created for these platforms.


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.

@martin-g
Copy link
Contributor Author

martin-g commented Oct 4, 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 tidk-0.2.63-h2e7e638_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 tidk-0.2.63-hd2a67f9_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-arm64 tidk-0.2.63-ha48a4ba_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/457b224a-d733-48b8-9cf0-525b545bcb97/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 tidk-0.2.63-h7b3948c_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/3d4c46ad-8683-4d78-891f-c90e7bcd733b/artifacts/0/tmp/artifacts/packages <package name>

Docker image(s) built:

Package Tag CI Install with docker
tidk 0.2.63--h2e7e638_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/tidk:0.2.63--h2e7e638_1.tar.gz | docker load

@martin-g
Copy link
Contributor Author

martin-g commented Oct 4, 2024

mgrigorov in 🌐 euler-arm-22 in /tmp/tidk via 🅒 test123 took 9s 
❯ tar xvf tidk-0.2.63-h7b3948c_1.tar.bz2                                                                                                                                                                   (test123) 
info/files
info/test/run_test.sh
info/run_exports.json
info/recipe/build.sh
info/paths.json
info/hash_input.json
info/index.json
info/recipe/meta.yaml.template
info/recipe/meta.yaml
info/recipe/conda_build_config.yaml
info/about.json
info/git
bin/tidk

mgrigorov in 🌐 euler-arm-22 in /tmp/tidk via 🅒 test123 
❯ file bin/*                                                                                                                                                                                               (test123) 
bin/tidk: ELF 64-bit LSB pie executable, ARM aarch64, version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-aarch64.so.1, for GNU/Linux 3.7.0, not stripped

mgrigorov in 🌐 euler-arm-22 in /tmp/tidk via 🅒 test123 
❯ ./bin/tidk                                                                                                                                                                                               (test123) 
Warning! No clades found in the database. Run 'tidk build' to fetch the latest data.

A Telomere Identification Toolkit.

Usage: tidk [COMMAND]

Commands:
  build    Build the reference database of telomeric repeat sequences. This is required for the 'find' subcommand.
  find     Supply the name of a clade your organsim belongs to, and this submodule will find all telomeric repeat matches for that clade.
  explore  Use a range of kmer sizes to find potential telomeric repeats.
           One of either length, or minimum and maximum must be specified.
  search   Search the input genome with a specific telomeric repeat search string.
  plot     SVG plot of TSV generated from tidk search.
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

LGTM!

@martin-g
Copy link
Contributor Author

martin-g commented Oct 4, 2024

@BiocondaBot please add label

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 please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants