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 new package kestrel in version 1.0.3 #51810

Merged
merged 6 commits into from
Nov 16, 2024
Merged

Conversation

holtgrewe
Copy link
Contributor

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

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces two new files in the recipes/kestrel directory: build.sh and meta.yaml. The build.sh script enhances the installation process for the Kestrel package by implementing strict error handling and control flow improvements. It begins by setting strict error handling options, constructs a path using environment variables, creates the necessary directory structure, copies files, modifies permissions for the Kestrel executable, and checks for existing symbolic links before creating one for easier access. The meta.yaml file defines the metadata and configuration for the Kestrel package, specifying its name and version, source URL with a SHA256 checksum, and build configuration indicating it is architecture-independent. It includes requirements for the openjdk version, test commands for validation, and an about section detailing the project's homepage, licensing, and functionality as a variant caller for short-read Illumina data.

Possibly related PRs

  • Add JARVIS3 recipe. #51730: The build.sh script in the JARVIS3 recipe also includes enhancements for the build process, similar to the error handling and control flow improvements made in the build.sh for Kestrel.
  • Add recipe for stxtyper v1.0.25 #51792: The build.sh script for stxtyper introduces a build process that sets environment variables and compiles code, paralleling the enhancements made in the Kestrel build.sh script.

Suggested labels

please review & merge


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

🧹 Outside diff range and nitpick comments (1)
recipes/kestrel/build.sh (1)

9-9: Remove trailing empty lines.

The script has unnecessary empty lines at the end.

Remove the extra newlines at the end of the file.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8cc8796 and 7fbf331.

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

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

(syntax)


[warning] 37-37: too many blank lines

(1 > 0) (empty-lines)

🔇 Additional comments (4)
recipes/kestrel/meta.yaml (4)

16-17: Review run_exports configuration.

The run_exports section with max_pin="x" will only allow updates to minor and patch versions. Given this is a new package, please confirm if this is the intended pinning strategy for maintaining ABI compatibility.


19-25: Consider adding build requirements.

While runtime requirements are specified, build requirements might be needed if any compilation or setup is required during the package installation.

#!/bin/bash
# Check if there's a setup.py or similar build script in the source
curl -sL "https://github.com/paudano/kestrel/releases/download/1.0.3/kestrel-1.0.3-linux.tar.gz" | tar tz | grep -E "setup\.py|configure|CMakeLists\.txt|Makefile"

34-35: Verify license information.

Please ensure:

  1. The license is correctly specified as "GPL-3.0" (standard SPDX identifier)
  2. The COPYING file is actually included in the source distribution
#!/bin/bash
# Check if COPYING file exists in the release tarball
curl -sL "https://github.com/paudano/kestrel/releases/download/1.0.3/kestrel-1.0.3-linux.tar.gz" | tar tz | grep -i "copying\|license"

Apply this diff to use the standard SPDX identifier:

-  license: GPL 3
+  license: GPL-3.0

8-10: ⚠️ Potential issue

Update SHA256 checksum for version 1.0.5.

The SHA256 checksum needs to be updated to match the 1.0.5 release tarball.

recipes/kestrel/build.sh Outdated Show resolved Hide resolved
recipes/kestrel/build.sh Show resolved Hide resolved
recipes/kestrel/build.sh Outdated Show resolved Hide resolved
Comment on lines 1 to 9
#!/bin/bash

kestrel=$PREFIX/opt/$PKG_NAME-$PKG_VERSION
mkdir -p $kestrel
cp -r ./* $kestrel
chmod +x $kestrel/kestrel
mkdir -p $PREFIX/bin
ln -s $kestrel/kestrel $PREFIX/bin/kestrel

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

Version inconsistency confirmed: meta.yaml shows 1.0.3 while PR targets 1.0.5

The meta.yaml file explicitly sets the version to 1.0.3:

{% set version = "1.0.3" %}

This needs to be updated to match the intended version 1.0.5 mentioned in the PR objectives.

🔗 Analysis chain

Verify package version consistency.

The AI summary mentions version 1.0.3, but the PR objectives state version 1.0.5.

Let's verify the version in meta.yaml:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check package version in meta.yaml
grep "version:" recipes/kestrel/meta.yaml

Length of output: 66


Script:

#!/bin/bash
# Let's check the package version from multiple sources
cat recipes/kestrel/meta.yaml

Length of output: 1023

recipes/kestrel/build.sh Outdated Show resolved Hide resolved
recipes/kestrel/build.sh Outdated Show resolved Hide resolved
Comment on lines 27 to 30
test:
commands:
- fastqc
- fastqc -h
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

Incorrect test commands.

The test commands are checking for fastqc which is a different tool. The tests should verify the kestrel executable instead.

Replace with appropriate test commands:

test:
  commands:
-    - fastqc
-    - fastqc -h 
+    - kestrel --version
+    - kestrel --help
📝 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
test:
commands:
- fastqc
- fastqc -h
test:
commands:
- kestrel --version
- kestrel --help

recipes/kestrel/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: 0

🧹 Outside diff range and nitpick comments (1)
recipes/kestrel/meta.yaml (1)

27-30: Consider adding more comprehensive tests.

While basic command presence tests are included, consider adding:

  • Version output verification
  • Basic functionality test with sample data
 test:
   commands:
     - kestrel
-    - kestrel -h 
+    - kestrel -h
+    - kestrel --version | grep {{ version }}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7fbf331 and eec963b.

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

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

(syntax)


[warning] 37-37: too many blank lines

(1 > 0) (empty-lines)

🔇 Additional comments (5)
recipes/kestrel/meta.yaml (5)

1-2: Version mismatch with PR objective still present.

🧰 Tools
🪛 yamllint

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

(syntax)


19-25: LGTM! Well-documented requirements section.

The OpenJDK version requirement is properly specified with good documentation explaining the channel constraint.


32-36: Verify license file presence.

The meta.yaml references a COPYING file for the license.


16-17: Consider if strict version pinning is necessary.

The run_exports section with pin_subpackage will enforce strict version matching. For a new package, this might be unnecessarily restrictive unless there are specific ABI compatibility concerns.


9-10: Verify SHA256 checksum for the package.

The checksum should be verified against the official release to ensure package integrity.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@holtgrewe holtgrewe changed the title Add new package kestrel in version 1.0.5 Add new package kestrel in version 1.0.3 Oct 31, 2024
@holtgrewe
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 31, 2024
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/kestrel/build.sh (1)

9-9: Add version verification after installation.

Consider adding a version check after installation to ensure the correct version is installed and executable.

 chmod +x "${kestrel}/kestrel"
+# Verify installed version
+if ! "${kestrel}/kestrel" --version 2>&1 | grep -q "${PKG_VERSION}"; then
+    echo "Error: Installed version does not match expected version ${PKG_VERSION}"
+    exit 1
+fi
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eec963b and dfd53c7.

📒 Files selected for processing (1)
  • recipes/kestrel/build.sh (1 hunks)

recipes/kestrel/meta.yaml Outdated 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: 1

🧹 Outside diff range and nitpick comments (1)
recipes/kestrel/meta.yaml (1)

27-30: Consider adding version check to test commands.

While the current tests verify basic command availability, adding a version check would ensure the correct version is installed.

 test:
   commands:
     - kestrel
-    - kestrel -h 
+    - kestrel -h
+    - kestrel --version  # Add version check
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dfd53c7 and f81fe62.

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

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

(syntax)


[warning] 38-38: too many blank lines

(1 > 0) (empty-lines)

🔇 Additional comments (4)
recipes/kestrel/meta.yaml (4)

12-18: LGTM! Build configuration follows best practices.

The build configuration is well-structured:

  • noarch: generic is appropriate for Java applications
  • Version pinning through run_exports ensures ABI compatibility

19-25: LGTM! Well-documented requirements.

The openjdk requirement is properly specified with:

  • Clear version constraint
  • Excellent documentation explaining the version choice
  • Proper channel enforcement

1-38: LGTM! Well-structured Bioconda recipe.

The recipe follows Bioconda best practices with:

  • Proper templating
  • Clear documentation
  • Appropriate dependencies
  • Necessary metadata
🧰 Tools
🪛 yamllint

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

(syntax)


[warning] 38-38: too many blank lines

(1 > 0) (empty-lines)


8-10: Verify source URL and checksum.

The URL structure looks correct, but let's verify its accessibility and the SHA256 checksum.

Comment on lines +32 to +37
about:
home: 'https://github.com/paudano/kestrel'
license: GPL-3.0-or-later
license_family: GPL3
license_file: COPYING
summary: 'Mapping-free variant caller for short-read Illumina data'
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

Homepage is accessible but COPYING file is missing

The homepage URL is valid and accessible (HTTP 200 response). However, I don't see a COPYING file in the kestrel recipe directory, which is required as specified in the meta.yaml. Other license files exist in various recipe directories, but not for kestrel.

🔗 Analysis chain

Verify license file and homepage.

The about section looks good, but let's verify:

  1. The existence of the COPYING file in the source
  2. The accessibility of the homepage
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify homepage accessibility
curl -sI 'https://github.com/paudano/kestrel' | head -n 1

# Note: Can't verify COPYING file without downloading and extracting the source

Length of output: 69


Script:

#!/bin/bash
# Search for COPYING file in the repository
fd "COPYING" --type f --hidden

# Check if there's any other license file that might be renamed
fd -i "license|copying" --type f --hidden

Length of output: 8481

@bioconda bioconda deleted a comment from coderabbitai bot Nov 16, 2024
@bioconda bioconda deleted a comment from coderabbitai bot Nov 16, 2024
@bgruening bgruening merged commit 072d656 into master Nov 16, 2024
6 checks passed
@bgruening bgruening deleted the new-recipe-kestrel-1.0.3 branch November 16, 2024 20:09
@holtgrewe
Copy link
Contributor Author

@berntpopp - this might come in handy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants