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 kleborate v3 #51156

Merged
merged 9 commits into from
Oct 4, 2024
Merged

Update kleborate v3 #51156

merged 9 commits into from
Oct 4, 2024

Conversation

Marysteph
Copy link
Contributor

@Marysteph Marysteph commented Oct 4, 2024

Describe your pull request here

Updated kleborate v3.0.9 to v3.1.0

Updated SHA256


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>.

Summary by CodeRabbit

  • New Features

    • Updated package name to "kleborate" and version to "3.1.0".
    • Added new dependencies including numpy, dna_features_viewer, and minimap2.
    • Introduced entry points for easier package usage.
  • Bug Fixes

    • Improved path resolution for Kaptive-related files.
  • Documentation

    • Updated home, development, and documentation URLs for better accessibility.
    • Revised license information to "GPL-3.0-or-later".

Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request includes the deletion of the build.sh script and the get_kaptive_paths() function from kaptive.py, along with significant updates to the meta.yaml file for the Kleborate package. The package name and version have been changed, dependencies have been updated, and new entries have been added to the build and test sections. Additionally, the source URL and license information have been modified.

Changes

File Path Change Summary
recipes/kleborate/build.sh Deleted the shell script that set up the Kleborate environment, installed the Python package, and created BLAST databases from Kleborate data.
recipes/kleborate/kaptive.py Deleted get_kaptive_paths() function; replaced original path resolution logic with a direct method using shutil.which('kaptive.py') to locate Kaptive-related files.
recipes/kleborate/meta.yaml Updated package name from "Kleborate" to "kleborate", version from "2.3.2" to "3.1.0", modified source URL and SHA256 checksum, raised minimum Python version, updated biopython requirement, added new dependencies, and revised metadata.

Suggested labels

autobump, new version


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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6e47c8f and 8064254.

📒 Files selected for processing (3)
  • recipes/kleborate/build.sh (0 hunks)
  • recipes/kleborate/fix_get_kaptive_path.patch (0 hunks)
  • recipes/kleborate/meta.yaml (1 hunks)
💤 Files with no reviewable changes (2)
  • recipes/kleborate/build.sh
  • recipes/kleborate/fix_get_kaptive_path.patch
🧰 Additional context used
🪛 yamllint
recipes/kleborate/meta.yaml

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

(syntax)

🔇 Additional comments (6)
recipes/kleborate/meta.yaml (6)

11-20: LGTM! Build section updated with appropriate configurations.

The build section has been updated with correct entry points, build script, and run_exports directive. These changes ensure proper installation and version pinning for downstream dependencies.


35-41: LGTM! Test section updated with appropriate checks.

The test section has been improved with the addition of an imports test and updated command-line tests. These changes ensure that the package is installed correctly and its CLI functions as expected.


52-59: LGTM! Extra metadata added to enhance package information.

The extra section has been populated with valuable metadata, including recipe maintainers and identifiers. This information enhances the discoverability and credibility of the package.


1-2: Ignore yamllint warning about '%' character.

The yamllint tool reports a syntax error for the '%' character at the beginning of the file. This is a false positive as the '%' is part of the Jinja2 templating syntax used in Conda recipes. The current syntax is correct and should not be changed.

🧰 Tools
🪛 yamllint

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

(syntax)


43-50: LGTM! About section updated with comprehensive information.

The about section has been updated with more detailed and accurate information, including new URLs and a more specific license identifier.

Please verify that the LICENSE file in the package repository matches the specified GPL-3.0-or-later license:

✅ Verification successful

LGTM! LICENSE file matches the specified GPL-3.0-or-later license.

The LICENSE file begins with the GNU General Public License Version 3, ensuring compliance with the specified license.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the content of the LICENSE file
curl -sL "https://raw.githubusercontent.com/klebgenomics/Kleborate/main/LICENSE" | head -n 5

Length of output: 107


Script:

#!/bin/bash
# Correctly check the content of the LICENSE file
curl -sL "https://raw.githubusercontent.com/klebgenomics/Kleborate/main/LICENSE" | head -n 5

Length of output: 318


1-10: LGTM! Package metadata and source updated correctly.

The package name, version, source URL, and SHA256 checksum have been updated appropriately. The change from GitHub to PyPI as the source is a good practice for Python packages.

To ensure the integrity of the package, please verify the SHA256 checksum:

🧰 Tools
🪛 yamllint

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

(syntax)

Comment on lines 22 to 33
requirements:
host:
- python >=3.7
- biopython >=1.73,<1.78
- kaptive
- blast >=2.2.31
- mash
- pip
- python >=3.9
run:
- python >=3.7
- biopython >=1.73,<1.78
- kaptive
- blast >=2.2.31
- python >=3.9
- biopython >=1.83
- numpy >=1.22
- dna_features_viewer
- minimap2
- mash
- kaptive
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

Dependencies Updated Without Documentation

The dependency changes in recipes/kleborate/meta.yaml are not documented in the project's changelog or release notes. Please update the documentation to reflect these updates for version 3.1.0.

🔗 Analysis chain

LGTM! Dependencies updated, but please verify documentation.

The requirements have been updated appropriately with new minimum versions and additional dependencies. These changes likely support new features in Kleborate 3.1.0.

Please ensure that these dependency changes are documented in the package's changelog or release notes. You can verify this by checking the project's documentation:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for changelog or release notes
curl -sL "https://raw.githubusercontent.com/klebgenomics/Kleborate/main/CHANGELOG.md" | grep -i "3.1.0" -A 10

Length of output: 107


Script:

#!/bin/bash
# Check GitHub releases for version 3.1.0
curl -s "https://api.github.com/repos/klebgenomics/Kleborate/releases" | jq -r '.[] | select(.tag_name == "v3.1.0") | .name, .body'

Length of output: 131


Script:

#!/bin/bash
# Search for version 3.1.0 in the entire codebase
rg "3\.1\.0" --context 3

Length of output: 47423

@martin-g martin-g merged commit 0482dfd into bioconda:master Oct 4, 2024
7 checks passed
This was referenced Oct 30, 2024
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