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

Update diamond recipe #51515

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Update diamond recipe #51515

merged 1 commit into from
Oct 21, 2024

Conversation

mencian
Copy link
Contributor

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

Copy link
Contributor

coderabbitai bot commented Oct 21, 2024

📝 Walkthrough

Walkthrough

The pull request introduces significant changes to the build.sh script and the meta.yaml file for the diamond package. In build.sh, the script has been streamlined by removing backup file creation during the sed command and consolidating the cmake command into a single line, which includes various parameters for the build process. A new conditional block has been added to handle macOS-specific configurations. The final build command has been updated to specify the build directory explicitly. In meta.yaml, the version number remains the same, but the build number has been incremented. The zlib dependency has been removed, and several formatting changes have been made to the about section, including the addition of a dev_url field. Additionally, the identifiers list has been updated, and the additional-platforms section has been reformatted for clarity.

Possibly related PRs

  • Update diamond to 2.1.10 #51496: This PR updates the diamond package version and includes changes to the meta.yaml file, which is directly related to the modifications made in the main PR for the diamond package.
  • Added support for extra platforms. #51505: This PR also modifies the meta.yaml file for the diamond package, adding support for extra platforms and removing a dependency, which aligns with the changes in the main PR.

Suggested labels

new version, please review & merge

Suggested reviewers

  • bbuchfink

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 (2)
recipes/diamond/meta.yaml (1)

42-45: LGTM: Improved identifiers with a minor suggestion.

The changes to the identifiers section are beneficial:

  1. The casing change for 'biotools:diamond' improves consistency with standard naming conventions.
  2. The addition of Galaxy-related identifiers provides valuable information for Galaxy platform users.

These updates enhance the discoverability and integration of the package with various platforms.

Consider alphabetizing the list of identifiers for better readability and easier maintenance. Here's a suggested order:

  identifiers:
    - biotools:diamond
    - doi:10.1038/s41592-021-01101-x
    - usegalaxy-eu:bg_diamond
    - usegalaxy-eu:bg_diamond_makedb
    - usegalaxy-eu:bg_diamond_view
recipes/diamond/build.sh (1)

6-6: Use $(uname) instead of backticks for command substitution

For better readability and to avoid issues with nested commands, it's recommended to use $(...) instead of backticks for command substitution in Bash scripts.

Apply this diff:

-if [[ `uname` == "Darwin" ]]; then
+if [[ $(uname) == "Darwin" ]]; then
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 50fd1c1 and a0ae0cf.

📒 Files selected for processing (2)
  • recipes/diamond/build.sh (1 hunks)
  • recipes/diamond/meta.yaml (2 hunks)
🧰 Additional context used
🔇 Additional comments (4)
recipes/diamond/meta.yaml (4)

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

The build number has been correctly incremented from 1 to 2. This is the proper approach when making changes to a package without altering its version.


32-33: LGTM: Improvements to the 'about' section.

The changes to the 'about' section are beneficial:

  1. Adding quotes to 'home' and 'license' fields improves consistency and prevents potential YAML parsing issues.
  2. The period at the end of the summary improves readability.
  3. The new 'dev_url' field provides useful information for developers.

These changes enhance the metadata quality and user experience.

Also applies to: 36-36, 38-38


46-48: LGTM: Improved formatting for 'additional-platforms'.

The indentation adjustment in the 'additional-platforms' section enhances the readability of the YAML file. The listed platforms (osx-arm64 and linux-aarch64) remain correct and relevant.


Line range hint 19-30: Verify the removal of zlib from run requirements.

The 'zlib' dependency has been removed from the run requirements while being retained in the host requirements. This suggests that zlib is needed during build time but not at runtime. However, given that the package uses 'run_exports', it's important to ensure that zlib is indeed not needed at runtime.

Please confirm that:

  1. Diamond doesn't require zlib at runtime.
  2. The removal of this run requirement won't cause any runtime issues.

If zlib is actually needed at runtime, consider adding it back to the run requirements or using run_exports for zlib in its recipe to automatically add it as a runtime dependency.

To help verify this change, you can run the following command to check if the diamond binary has any runtime dependencies on zlib:

If this command returns any results, it indicates that zlib is still a runtime dependency and should be included in the run requirements.

-DZSTD_LIBRARY="${PREFIX}/lib/libzstd.a" \
-DZSTD_INCLUDE_DIR="${PREFIX}/include" \
-DBLAST_LIBRARY_DIR="${PREFIX}/lib/ncbi-blast+" \
-DCMAKE_OSX_DEPLOYMENT_TARGET="" \
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

Do not override CMAKE_OSX_DEPLOYMENT_TARGET

Setting CMAKE_OSX_DEPLOYMENT_TARGET to an empty string may lead to macOS compatibility issues. Conda-build manages this variable appropriately. It's best to rely on the defaults provided by the build environment.

Apply this diff:

 -DCMAKE_OSX_DEPLOYMENT_TARGET="" \

Committable suggestion was skipped due to low confidence.

cmake -S. -B build -DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX="${PREFIX}" \
-DCMAKE_CXX_COMPILER="${CXX}" \
-DCMAKE_CXX_FLAGS="${CXXFLAGS} -O3 -I${PREFIX}/include" \
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

Avoid overriding optimization flags in CXXFLAGS

Conda-build sets appropriate optimization flags in CXXFLAGS. Adding -O3 may conflict with these settings and affect portability. It's recommended not to override optimization levels explicitly.

Apply this diff:

 -DCMAKE_CXX_FLAGS="${CXXFLAGS} -O3 -I${PREFIX}/include" \
+-DCMAKE_CXX_FLAGS="${CXXFLAGS} -I${PREFIX}/include" \
📝 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
-DCMAKE_CXX_FLAGS="${CXXFLAGS} -O3 -I${PREFIX}/include" \
-DCMAKE_CXX_FLAGS="${CXXFLAGS} -I${PREFIX}/include" \

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant