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

Add amplici package in bioconda #51847

Merged
merged 17 commits into from
Nov 2, 2024
Merged

Conversation

xiyupeng
Copy link
Contributor

@xiyupeng xiyupeng commented Oct 31, 2024

Add amplici package in bioconda.

This is the first contribut. Feel free to comment. Thanks!


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 31, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces two main components for the amplici package: a build script (build.sh) and a metadata file (meta.yaml). The build.sh script includes a conditional check for the operating system, specifically setting the CONFIG_ARGS environment variable based on whether the script is executed on macOS or another operating system. It then changes the directory to src and executes the cmake command with various parameters, followed by initiating the build process with cmake --build. The meta.yaml file specifies the package's metadata, including its name and version, source URL, checksum, build requirements, and additional information such as the project's homepage and licensing details. It also includes a test command to verify installation and outlines supported platforms and identifiers for tracking purposes.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • martin-g
  • mencian

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1cd294a and 1ce08d6.

📒 Files selected for processing (1)
  • recipes/amplici/build.sh (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/amplici/build.sh

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

🧹 Outside diff range and nitpick comments (2)
recipes/amplici/meta.yaml (2)

14-16: Remove or address the TODO comment.

The comment about adding more critical dependencies should be removed if there are no additional dependencies to pin, or replaced with actual dependencies if needed.

 run_exports:
   - {{ pin_subpackage("amplici", max_pin="x") }}
-    # Add more if there are other critical dependencies that require pinning

30-34: Minor improvements needed in the about section.

Please:

  1. Remove trailing spaces after BSD in license_family
  2. Consider adding a license_file field to specify the location of the license file
 about:
   home: https://github.com/DormanLab/AmpliCI
   license: BSD 3-Clause 
-  license_family: BSD  
+  license_family: BSD
+  license_file: LICENSE  # Add the path to the license file
🧰 Tools
🪛 yamllint

[error] 33-33: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a99ab47 and ec0e6cc.

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

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


[error] 33-33: trailing spaces

(trailing-spaces)

🔇 Additional comments (3)
recipes/amplici/meta.yaml (3)

40-48: LGTM! Extra section is well-documented.

The section includes all necessary information:

  • Additional platform support
  • Recipe maintainer
  • Appropriate identifiers (biotools and DOI)

1-48: Verify bioconda-specific requirements.

The package appears to be biologically relevant (handles amplicon sequences) which is appropriate for bioconda. However, please ensure:

  1. The package follows bioconda's naming conventions
  2. All dependencies are available in bioconda or conda-forge
#!/bin/bash
# Check if dependencies are available in bioconda/conda-forge
conda search -c bioconda -c conda-forge cmake make gfortran
🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


[error] 33-33: trailing spaces

(trailing-spaces)


19-28: Consider adding run requirements and version constraints.

The recipe is missing:

  1. Run requirements section which typically specifies runtime dependencies
  2. Version constraints for cmake and other build dependencies

Please verify if the package has any runtime dependencies that should be listed.

recipes/amplici/build.sh Outdated Show resolved Hide resolved
recipes/amplici/build.sh Outdated Show resolved Hide resolved
recipes/amplici/build.sh Outdated Show resolved Hide resolved
recipes/amplici/meta.yaml Show resolved Hide resolved
recipes/amplici/meta.yaml Show resolved Hide resolved
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/amplici/build.sh (1)

3-7: Improve OS detection robustness.

Good practice adding macOS-specific CMake configuration. Consider these improvements:

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

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ec0e6cc and 1cd294a.

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

[warning] 9-9: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

🪛 yamllint
recipes/amplici/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (8)
recipes/amplici/build.sh (1)

1-2: Add error handling at script start.

The script should include error handling flags to fail fast on errors.

recipes/amplici/meta.yaml (7)

1-6: LGTM! Version and package metadata are properly configured.

The version mismatch issue from the previous review has been resolved.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


11-15: LGTM! Build settings follow best practices.

The run_exports configuration will help maintain ABI compatibility.


26-32: LGTM! Package metadata is complete and well-documented.

All required fields are present, including license file reference and development URLs.


34-36: Previous suggestion for comprehensive tests still applies.

Referring to the previous review comment about adding more comprehensive tests.


38-46: LGTM! Extra metadata is comprehensive.

Excellent inclusion of platform support, maintainer information, and scientific identifiers.


16-25: Verify if run-time dependencies are needed.

While build and host dependencies look correct, there are no run-time dependencies specified. Please verify if the package requires any runtime dependencies, particularly:

  1. zlib (since it's a host dependency)
  2. Any runtime libraries needed for sequence processing
#!/bin/bash
# Description: Check for potential runtime dependencies
# Look for shared library dependencies in the source
rg -l "include.*zlib\.h|include.*stdlib\.h|include.*stdio\.h"

7-10: Verify the source tarball checksum.

The URL format is correct, but let's verify the SHA256 checksum matches the source tarball.

recipes/amplici/build.sh Outdated Show resolved Hide resolved
recipes/amplici/build.sh Show resolved Hide resolved
@xiyupeng
Copy link
Contributor Author

xiyupeng commented Nov 1, 2024

Edit the CMakeList file of AmpliCI

  • relax the requirement of using gcc and gfortran as compiler.

Update to use the latest version v2.2 of AmpliCI

@bgruening bgruening enabled auto-merge (squash) November 2, 2024 19:04
@bgruening
Copy link
Member

Thanks @xiyupeng

@bgruening bgruening merged commit 3fbd693 into bioconda:master Nov 2, 2024
6 checks passed
@xiyupeng xiyupeng deleted the update_recipe_2 branch November 2, 2024 19:33
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.

3 participants