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 kmer-db to 2.2.2 #48760

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Update kmer-db to 2.2.2 #48760

wants to merge 10 commits into from

Conversation

BiocondaBot
Copy link
Collaborator

@BiocondaBot BiocondaBot commented Jun 26, 2024

Update kmer-db: 1.11.12.2.2

install with bioconda Conda

Info Link or Description
Recipe recipes/kmer-db (click to view/edit other files)
Summary Kmer-db is a fast and memory-efficient tool for estimating evolutionary distances.
Home https://github.com/refresh-bio/kmer-db
Releases https://github.com/refresh-bio/kmer-db/tags
Author @refresh-bio

This pull request was automatically generated (see docs).

@BiocondaBot BiocondaBot added autobump Automatic Version Update new version labels Jun 26, 2024
@BiocondaBot BiocondaBot changed the title Update kmer-db to 2.0.2 Update kmer-db to 2.0.3 Jun 28, 2024
@BiocondaBot BiocondaBot changed the title Update kmer-db to 2.0.3 Update kmer-db to 2.0.4 Aug 20, 2024
@BiocondaBot BiocondaBot changed the title Update kmer-db to 2.0.4 Update kmer-db to 2.0.5 Sep 12, 2024
Copy link

coderabbitai bot commented Oct 3, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces changes to the kmer-db package, specifically updating the build.sh script and the meta.yaml file. The build.sh script enhancements include improved execution behavior, exporting compilation flags, and enabling parallel builds. The meta.yaml file reflects a version bump from "1.11.1" to "2.2.0", updates to the SHA256 checksum, dynamic package naming, and modifications to the requirements and license information, among other adjustments.

Changes

File Path Change Summary
recipes/kmer-db/build.sh Updated shebang to #!/bin/bash -euo for enhanced execution, exported CFLAGS and LDFLAGS, added -j "${CPU_COUNT}" to make for parallel compilation, and reformatted installation commands.
recipes/kmer-db/meta.yaml Updated version to "2.2.0", changed SHA256 checksum, set package name dynamically, reset build number to 0, added run_exports, modified requirements, reintroduced test section, updated license information, and added dev_url.

Possibly related PRs


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.

@BiocondaBot BiocondaBot changed the title Update kmer-db to 2.0.5 Update kmer-db to 2.2.0 Oct 3, 2024
Copy link

@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: 0

🧹 Outside diff range and nitpick comments (3)
recipes/kmer-db/build.sh (2)

1-1: LGTM with a minor suggestion.

The updated shebang line with -eu flags improves the script's robustness by exiting on errors and treating unset variables as errors. However, the -o flag is not a valid bash option on its own.

Consider changing the shebang to #!/bin/bash -euo pipefail to enable the pipefail option, which causes a pipeline to return the exit status of the last command that exited with a non-zero status.


6-6: LGTM with a minor suggestion.

The addition of -j "${CPU_COUNT}" to the make command enables parallel compilation, which can significantly speed up the build process by utilizing all available CPU cores.

Consider adding a fallback value for CPU_COUNT in case it's not set:

-make CC="${CXX}" -j "${CPU_COUNT}"
+make CC="${CXX}" -j "${CPU_COUNT:-1}"

This ensures the build will work even if CPU_COUNT is not set, defaulting to single-threaded compilation in such cases.

recipes/kmer-db/meta.yaml (1)

25-27: LGTM: Test command added. Consider enhancing the test.

Adding a test command is a good practice. It ensures that the kmer-db command can be executed after installation.

Suggestion: Consider enhancing the test to verify the version or a specific functionality of kmer-db. For example:

test:
  commands:
    - kmer-db --version
    - kmer-db --help

This would provide stronger validation of the installed package.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between eaabca1 and aba8e39.

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

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

(syntax)

🔇 Additional comments (9)
recipes/kmer-db/build.sh (3)

3-3: LGTM! Proper export of CFLAGS.

The CFLAGS are now correctly exported, ensuring they're available to subprocesses. The -O3 flag enables high-level optimizations, and the include path is set correctly using the PREFIX variable.


4-4: LGTM! Proper export of LDFLAGS.

The LDFLAGS are now correctly exported, ensuring they're available to subprocesses. The library path is set correctly using the PREFIX variable.


1-8: Overall, these changes significantly improve the build script.

The modifications enhance the script's robustness, optimize compilation, and ensure proper environment variable handling. The parallel compilation feature is particularly beneficial for speeding up the build process on multi-core systems.

A few minor suggestions were made:

  1. Consider adding -o pipefail to the shebang line for improved error handling in pipelines.
  2. Add a fallback value for CPU_COUNT in the make command to ensure it works even if the variable is not set.

These changes align well with the PR objective of updating kmer-db to version 2.0.5, as they improve the build process for the new version.

recipes/kmer-db/meta.yaml (6)

6-6: LGTM: Improved package name consistency.

Using a Jinja2 variable for the package name is a good practice. It ensures consistency throughout the recipe and makes future updates easier.


13-17: LGTM: Appropriate build configuration updates.

The changes in the build section look good:

  1. Resetting the build number to 0 is correct for a new version.
  2. Adding the run_exports section with pinning is a good practice for maintaining ABI compatibility.

These changes will help ensure smooth updates and compatibility for downstream packages.


29-35: LGTM: Improved metadata in the about section.

The changes in the about section are all positive:

  1. The license has been updated to "GPL-3.0-or-later", which provides more clarity on the allowed GPL versions.
  2. The license family has been correctly updated to GPL3.
  3. Adding the dev_url is helpful for users who want to access the source code or contribute to the project.

These changes improve the package metadata and make it easier for users to understand the licensing and find the project repository.


1-3: Note on static analysis warning: False positive.

The yamllint tool reported a syntax error for the '%' character at the beginning of the file. This is a false positive as the '%' character is used for Jinja2 templating in Conda recipes and is valid in this context. No action is required to address this warning.

🧰 Tools
🪛 yamllint

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

(syntax)


1-3: Verify the version number.

The PR objective mentions updating to version 2.0.5, but the version variable is set to 2.2.0. Please confirm if this is the correct version to be used.

The use of Jinja2 variables for the package name and the updated SHA256 checksum look good.

To verify the correct version, please run the following script:

🧰 Tools
🪛 yamllint

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

(syntax)


18-24: Verify the removal of zlib run requirement.

The zlib run requirement has been removed from the recipe. Please confirm that this is intentional and that kmer-db no longer requires zlib at runtime in the new version.

If zlib is still needed, consider re-adding it to the run requirements.

To verify if zlib is still required, please run the following script:

@BiocondaBot BiocondaBot changed the title Update kmer-db to 2.2.0 Update kmer-db to 2.2.1 Oct 3, 2024
@BiocondaBot BiocondaBot changed the title Update kmer-db to 2.2.1 Update kmer-db to 2.2.2 Oct 4, 2024
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.

2 participants