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 ntedit to 2.1.0 #52248

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update ntedit to 2.1.0 #52248

wants to merge 1 commit into from

Conversation

lcoombe
Copy link
Contributor

@lcoombe lcoombe commented Nov 20, 2024

Updating ntEdit to 2.1.0, updating dependency


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 Nov 20, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the meta.yaml file of the ntedit package. The version number has been updated from 2.0.3 to 2.1.0, indicating a new release. Alongside this version increment, the SHA256 checksum for the source tarball has been altered to 14931b259c78b1ce66b5cddd3b5150bdac7b7846eaacb7eeeb14335b1fd2d753, reflecting changes in the source files. Additionally, the dependency on nthits has been replaced with ntstat, which now requires a minimum version of 1.0.1. All other dependencies in the requirements section remain unchanged. The overall structure of the meta.yaml file, including sections such as package, build, source, requirements, test, about, and extra, has not been modified beyond these specified updates.

Possibly related PRs

  • Update ntstat to 1.0.1 #52021: This PR updates the ntstat package, which is now a dependency in the main PR for the ntedit package, reflecting a direct relationship in terms of dependency management.

Suggested labels

autobump, new version

Suggested reviewers

  • bgruening
  • martin-g

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

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

Line range hint 18-26: Consider build system optimization

The recipe includes multiple build systems (cmake, make, automake, autoconf, meson, ninja). Consider documenting which build system is primarily used and if all are necessary. This could help reduce build dependencies and complexity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e140830 and 05734d7.

📒 Files selected for processing (1)
  • recipes/ntedit/meta.yaml (3 hunks)
🔇 Additional comments (3)
recipes/ntedit/meta.yaml (3)

2-2: Version update looks good!

The version bump to 2.1.0 matches the PR objectives and follows semantic versioning. The existing run_exports section with max_pin="x" will help maintain ABI compatibility with downstream dependencies.


15-15: Verify source integrity

Let's verify the source tarball and its checksum.


35-35: Verify dependency change impact

The replacement of nthits with ntstat is a significant change. Let's verify:

  1. The dependency change is documented in upstream
  2. The availability of ntstat in Bioconda
✅ Verification successful

Dependency change appears to be valid

Based on the verification results:

  1. The ntstat package is available in Bioconda with version 1.0.1, as evidenced by its recipe in recipes/ntstat/meta.yaml
  2. The package is from the same organization (bcgsc) as ntEdit
  3. The dependency is properly versioned (>=1.0.1)
  4. The package provides k-mer frequency and depth analysis functionality, which aligns with ntEdit's genome assembly polishing purpose
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify ntstat package availability and version in Bioconda

# Check if ntstat is available in Bioconda
conda search -c bioconda ntstat

# Check for any recipes that might be affected by this change
fd -t f meta.yaml -x rg -l "nthits|ntstat" {}

Length of output: 291


Script:

#!/bin/bash
# Let's check the content of ntstat recipe and its version
cat recipes/ntstat/meta.yaml

# Check ntedit recipe for any documentation about the dependency change
cat recipes/ntedit/meta.yaml

# Check if there are any recent changes to these files
git log --oneline -n 5 recipes/ntstat/meta.yaml recipes/ntedit/meta.yaml

Length of output: 2323


Script:

#!/bin/bash
# Let's check the upstream repository's changelog or release notes for documentation about this change
curl -sL https://raw.githubusercontent.com/bcgsc/ntEdit/v2.1.0/CHANGELOG.md || true

# Let's also check if nthits was previously a dependency
git show HEAD^ recipes/ntedit/meta.yaml

Length of output: 135

@lcoombe
Copy link
Contributor Author

lcoombe commented Nov 20, 2024

Pending building ntStat recipe for osx-arm64 and linux-aarch64

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.

1 participant