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 ncbi-amrfinderplus to 4.0.3 #51776

Merged
merged 8 commits into from
Oct 29, 2024
Merged

Update ncbi-amrfinderplus to 4.0.3 #51776

merged 8 commits into from
Oct 29, 2024

Conversation

BiocondaBot
Copy link
Collaborator

Update ncbi-amrfinderplus: 3.12.84.0.3

install with bioconda Conda

Info Link or Description
Recipe recipes/ncbi-amrfinderplus (click to view/edit other files)
Summary AMRFinderPlus finds antimicrobial resistance and other genes in protein or nucleotide sequences.
Home https://github.com/ncbi/amr/wiki
Releases https://github.com/ncbi/amr/tags
Recipe Maintainer(s) @evolarjun
Author @ncbi

This pull request was automatically generated (see docs).

@BiocondaBot BiocondaBot added autobump Automatic Version Update new version labels Oct 29, 2024
@evolarjun evolarjun self-assigned this Oct 29, 2024
Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request involves updates to the meta.yaml file for the ncbi-amrfinderplus package. The version has been changed from "3.12.8" to "4.0.3", and the SHA256 checksum has been updated from "a199bc332877bad9033a7620bc5e8e849db1f19a9ba8b7357ec5451a6a283aa0" to "e3007c074ac77e410914691b38d7eaaaaf2cda6c". The source section has been modified to replace the URL format with a git_url pointing to the repository and a git_rev indicating the new version tag. The previous URL format has been removed. The requirements section has been updated to include git as a build dependency and libcurl as a host dependency, while curl has been retained in the run dependencies. The about section has minor formatting changes, including the removal of unnecessary whitespace in the summary string. Additionally, a dev_url has been added, pointing to the GitHub repository. The extra section now includes skip-lints with entries for uses_vcs_url and missing_hash, indicating new linting rules to be skipped.

The build.sh script has also been modified to enhance its functionality. Changes include the addition of LDFLAGS for library paths, updates to CXXFLAGS for optimization, and the inclusion of a command to initialize a Git submodule. The make command now includes an additional include path, and the installation command has been updated to use INSTALL_DIR. A temporary bug fix for creating a symbolic link for stxtyper has been introduced, marked for removal in future releases.


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

🧹 Outside diff range and nitpick comments (1)
recipes/ncbi-amrfinderplus/meta.yaml (1)

Line range hint 31-46: Consider versioning test data sources.

Currently, test data is fetched from the master branch, which could lead to inconsistencies if the test files are updated. Consider fetching test data from the specific release tag (v4.0.3) instead.

-         -O https://raw.githubusercontent.com/ncbi/amr/master/test_dna.fa \
-         -O https://raw.githubusercontent.com/ncbi/amr/master/test_prot.fa \
-         -O https://raw.githubusercontent.com/ncbi/amr/master/test_prot.gff \
-         -O https://raw.githubusercontent.com/ncbi/amr/master/test_both.expected
+         -O https://raw.githubusercontent.com/ncbi/amr/amrfinder_v4.0.3/test_dna.fa \
+         -O https://raw.githubusercontent.com/ncbi/amr/amrfinder_v4.0.3/test_prot.fa \
+         -O https://raw.githubusercontent.com/ncbi/amr/amrfinder_v4.0.3/test_prot.gff \
+         -O https://raw.githubusercontent.com/ncbi/amr/amrfinder_v4.0.3/test_both.expected
🧰 Tools
🪛 yamllint

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

(syntax)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a1ca801 and a75ce87.

📒 Files selected for processing (1)
  • recipes/ncbi-amrfinderplus/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/ncbi-amrfinderplus/meta.yaml

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

(syntax)

🔇 Additional comments (3)
recipes/ncbi-amrfinderplus/meta.yaml (3)

Line range hint 14-17: Build configuration looks good!

The build number is correctly reset to 0 for the new version, and the run_exports pin specification is appropriate.

🧰 Tools
🪛 yamllint

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

(syntax)


Line range hint 48-67: Metadata is complete and well-documented!

All required fields including license, documentation, and identifiers are properly maintained.

🧰 Tools
🪛 yamllint

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

(syntax)


Line range hint 19-29: Verify dependency requirements for v4.0.3.

Please ensure that the existing dependency versions are still compatible with v4.0.3. Consider checking the release notes or changelog for any new requirements.

🧰 Tools
🪛 yamllint

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

(syntax)

Comment on lines 1 to 2
{% set version = "4.0.3" %}
{% set sha256 = "80ad1e217c78024633aa6e11052f6290b445414251372e4379c373915768564d" %}
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

Major version update (4.0.3) introduces breaking changes - requires database update

This version update includes significant changes that users need to be aware of:

  • Changed database format requiring users to run amrfinder -U to get database release 2024-10-22.1 or later
  • Modified column names in output to align with NCBI Pathogen Detection resources
  • Changes in database filename patterns and hierarchy node field format
  • Integration of StxTyper v1.0.27 for E. coli Stx operon typing

The package configuration in meta.yaml appropriately handles these changes:

  • Build number correctly reset to 0
  • Dependencies remain compatible
  • Test suite includes amrfinder -U command
  • Run exports properly pinned at major version level (x)
🔗 Analysis chain

Verify SHA256 and check for breaking changes.

This is a major version update (3.12.8 → 4.0.3) which might introduce breaking changes. Let's verify the source integrity.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the SHA256 checksum of the source tarball
curl -sL https://github.com/ncbi/amr/archive/amrfinder_v4.0.3.tar.gz | sha256sum

Length of output: 125


Script:

#!/bin/bash
# Let's try a different approach to verify the source and check for breaking changes

# 1. Check if the release exists and get its details
gh release view amrfinder_v4.0.3 --repo ncbi/amr --json body,tagName,name

# 2. Let's also look at the changelog or release notes in the repository
fd -g "CHANGELOG*" -g "RELEASE*" -g "HISTORY*" -X cat

# 3. Check meta.yaml for any dependency changes
cat recipes/ncbi-amrfinderplus/meta.yaml

Length of output: 3807

🧰 Tools
🪛 yamllint

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

(syntax)

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

🧹 Outside diff range and nitpick comments (1)
recipes/ncbi-amrfinderplus/build.sh (1)

20-26: Track removal of temporary bug fix

This temporary fix for the Makefile issue should be removed in the next version after 4.0.3. Consider creating a tracking issue to ensure this workaround is removed in future updates.

Would you like me to create a GitHub issue to track the removal of this temporary fix in the next version?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a75ce87 and 751cd3e.

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

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

(syntax)

🔇 Additional comments (8)
recipes/ncbi-amrfinderplus/build.sh (4)

4-4: LGTM: Improved debug output formatting

The simplified debug output maintains clarity while providing the same diagnostic information.


8-8: Verify the impact of -O3 optimization

While the LDFLAGS addition is necessary for proper linking, the -O3 optimization flag could potentially impact build time and binary size. Please ensure this optimization level doesn't cause any issues with the package functionality.

Consider benchmarking the build with and without -O3 to evaluate the trade-offs between performance and build time.

Also applies to: 11-11


16-16: LGTM: Proper usage of build environment variables

The make command correctly incorporates build flags and environment variables. The switch to INSTALL_DIR is appropriate for installation path specification.

Also applies to: 18-18


13-14: Verify git dependency in meta.yaml

The addition of git submodule initialization aligns with the switch to a git-based workflow. The AI summary indicates git was added as a build dependency in meta.yaml, which is correct.

✅ Verification successful

Git dependency is correctly declared in meta.yaml

The verification confirms that git is properly listed as a build dependency in meta.yaml, which is required for the git submodule initialization step in build.sh.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify git is listed as a build dependency
grep -A 5 "build:" recipes/ncbi-amrfinderplus/meta.yaml

Length of output: 248

recipes/ncbi-amrfinderplus/meta.yaml (4)

9-10: LGTM: Source configuration aligns with upstream versioning

The switch to git-based source with proper version tag is appropriate. The git_rev correctly references the upstream tag format amrfinder_v{{ version }}.


20-20: LGTM: Dependencies updated appropriately

The addition of git as a build dependency is required for the git-based source. The libcurl host dependency with curl run dependency is the correct pattern for proper runtime functionality.

Also applies to: 24-25


51-54: LGTM: Metadata improvements

The about section updates improve package metadata with proper dev_url and consistent formatting.

Also applies to: 62-62


1-2: Verify SHA256 format for git-based source

The SHA256 value appears to be a git commit hash rather than a tarball checksum. When using git_url, the SHA256 should still be the checksum of the downloaded content to ensure package integrity.

Let's verify the correct checksum:

✅ Verification successful

SHA256 value is correctly set for git-based source

The SHA256 value e3007c074ac77e410914691b38d7eaaaaf2cda6c is actually correct as it matches the git commit hash of the tag amrfinder_v4.0.3. The source section is properly configured to use git-based source with git_url and git_rev, and the SHA256 in this case is meant to verify the specific git commit rather than a tarball checksum.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Clone the repo and generate the correct checksum
git clone --depth 1 --branch amrfinder_v4.0.3 https://github.com/ncbi/amr.git tmp_amr
cd tmp_amr && find . -type f -print0 | sort -z | xargs -0 sha256sum | sha256sum

Length of output: 957


Script:

#!/bin/bash
# Let's verify if this is indeed a git commit hash by checking the repository
git ls-remote --tags https://github.com/ncbi/amr.git "refs/tags/amrfinder_v4.0.3"

# Also check the source section format in meta.yaml to understand how it's configured
cat recipes/ncbi-amrfinderplus/meta.yaml | grep -A 5 "source:"

Length of output: 330

🧰 Tools
🪛 yamllint

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

(syntax)

recipes/ncbi-amrfinderplus/meta.yaml Show resolved Hide resolved
@mencian mencian merged commit ab17a3c into master Oct 29, 2024
6 checks passed
@mencian mencian deleted the bump/ncbi_amrfinderplus branch October 29, 2024 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autobump Automatic Version Update new version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants