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

Build bindash on osx #51661

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Build bindash on osx #51661

merged 1 commit into from
Oct 25, 2024

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Oct 25, 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>.

@mencian mencian added the osx-arm64 Related to adding osx-arm64 support label Oct 25, 2024
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the build.sh and meta.yaml files for the Bindash project. In build.sh, environment variables such as INCLUDES, LIBPATH, and LDFLAGS are set to define include and library paths based on the PREFIX variable. A conditional block is added to adjust CONFIG_ARGS for macOS, disabling certain CMake features. The CMake command is updated to utilize -S and -B options for source and build directories, alongside additional flags for installation prefix and C++ compiler settings. The make command remains mostly unchanged, preserving its verbosity and parallel execution.

In meta.yaml, the version number is incremented from 2 to 3, and the run requirements see the removal of zlib. Formatting updates are made to the home, license, dev_url, and doc_url fields for consistency, with the addition of a new doc_url pointing to the README for the specific version. The extra section is updated to include osx-arm64 in the supported platforms list.

Possibly related PRs

Suggested labels

please review & merge, osx-arm64


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: 2

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

15-19: Document C++ standard requirement in meta.yaml.

The build script requires C++14, which should be documented in the package metadata.

Consider adding this requirement to meta.yaml:

requirements:
  build:
    - {{ compiler('cxx') }} >=5.0  # For C++14 support
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7952dbb and cb823f4.

📒 Files selected for processing (2)
  • recipes/bindash/build.sh (1 hunks)
  • recipes/bindash/meta.yaml (2 hunks)
🧰 Additional context used
🪛 Shellcheck
recipes/bindash/build.sh

[warning] 7-7: Use 'pushd ... || exit' or 'pushd ... || return' in case pushd fails.

(SC2164)

🔇 Additional comments (6)
recipes/bindash/build.sh (4)

3-5: LGTM: Environment variables are properly configured.

The environment variables are correctly set up using PREFIX, maintaining compatibility with both Linux and macOS builds.


9-13: LGTM: Proper macOS-specific CMake configuration.

The conditional block correctly configures CMake for macOS by disabling framework and app bundle finding, which is essential for conda/bioconda builds.


21-24: LGTM: Build and installation commands are well structured.

The parallel build and installation commands follow conda-build best practices.


1-24: Verify impact on downstream dependencies.

Since this is a Bioconda package build script modification, we should verify if any downstream packages depend on bindash.

✅ Verification successful

Let me verify the meta.yaml file to check if this package is used as a dependency by other packages.


Let me check if any other packages list bindash as a dependency by searching for it in requirements sections of other meta.yaml files.


Build script changes have minimal downstream impact

The verification shows that:

  1. No other packages in the bioconda-recipes repository depend on bindash
  2. The package provides run exports but is not used as a dependency elsewhere
  3. The changes are focused on platform-specific build configurations and don't affect the package interface
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for downstream dependencies in bioconda-recipes
# Look for references to bindash in meta.yaml files
rg -l "bindash" --glob "recipes/*/meta.yaml"

Length of output: 70


Script:

#!/bin/bash
# Check the content of bindash meta.yaml for test commands and package info
cat recipes/bindash/meta.yaml

Length of output: 1251


Script:

#!/bin/bash
# Search for bindash in requirements sections of meta.yaml files
rg -B2 -A2 "bindash" --glob "recipes/*/meta.yaml" | grep -v "name: bindash"

Length of output: 1548

🧰 Tools
🪛 Shellcheck

[warning] 7-7: Use 'pushd ... || exit' or 'pushd ... || return' in case pushd fails.

(SC2164)

recipes/bindash/meta.yaml (2)

13-15: LGTM: Build configuration is properly set up

The build number increment and run_exports pinning are correctly configured to maintain ABI compatibility.


46-46: LGTM: OSX ARM64 platform support properly configured

The addition of osx-arm64 platform support is consistent with the PR objectives and the necessary dependencies (llvm-openmp) are correctly specified in the requirements section.

export INCLUDES="-I${PREFIX}/include"
export LIBPATH="-L${PREFIX}/lib"
export LDFLAGS="${LDFLAGS} -L${PREFIX}/lib"

mkdir release && pushd release
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add error handling for directory operations.

The pushd command should handle potential failures to prevent silent build errors.

Apply this diff to add error handling:

-mkdir release && pushd release
+mkdir release || exit 1
+pushd release || exit 1
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
mkdir release && pushd release
mkdir release || exit 1
pushd release || exit 1
🧰 Tools
🪛 Shellcheck

[warning] 7-7: Use 'pushd ... || exit' or 'pushd ... || return' in case pushd fails.

(SC2164)

Comment on lines +35 to +36
home: "https://github.com/zhaoxiaofei/bindash"
license: "Apache-2.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Update documentation URLs to point to the original repository

The verification shows that jianshu93/bindash is a fork of zhaoxiaofei/bindash (the original repository). For consistency and long-term maintainability, all URLs should point to the original repository since:

  • zhaoxiaofei/bindash is the parent repository
  • jianshu93/bindash is marked as a fork
  • The README exists in both repositories

Please update the doc_url to point to the original repository: "https://github.com/zhaoxiaofei/bindash/blob/v2.3/README.md"

🔗 Analysis chain

Verify repository relationships and documentation links

The URLs point to different repositories:

  • home/dev_url: "zhaoxiaofei/bindash"
  • doc_url: "jianshu93/bindash"

This could lead to documentation inconsistencies or broken links if the repositories get out of sync.

Also applies to: 40-41

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository relationships and README existence

# Check if both repositories exist and their relationship
gh repo view zhaoxiaofei/bindash --json parent,isFork,defaultBranchRef
gh repo view jianshu93/bindash --json parent,isFork,defaultBranchRef

# Verify README existence at the specified version
gh api repos/jianshu93/bindash/contents/README.md?ref=v2.3 --jq '.sha'

Length of output: 506

@mencian mencian merged commit 313ee0a into master Oct 25, 2024
7 checks passed
@mencian mencian deleted the bindash branch October 25, 2024 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
osx-arm64 Related to adding osx-arm64 support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant