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 ntStat #51884

Merged
merged 3 commits into from
Nov 3, 2024
Merged

Add ntStat #51884

merged 3 commits into from
Nov 3, 2024

Conversation

parham-k
Copy link
Contributor

@parham-k parham-k commented Nov 3, 2024

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

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request introduces two new files: build.sh and meta.yaml in the ntstat directory. The build.sh script automates the setup and installation of the ntstat project using the Meson build system. It includes commands to configure the build with meson setup, specifying a release build type and an installation prefix from the $PREFIX environment variable, followed by the installation of the project via meson install. The meta.yaml file provides comprehensive metadata for the ntstat package, including its name, version (1.0.0), source URL, and SHA256 checksum for verification. It specifies build, host, and run requirements, detailing necessary dependencies for each stage. Additionally, the file includes test commands to verify the installation and an about section that describes the project, its license, and its homepage.

Possibly related PRs

  • recipe for pgrc #50973: The build.sh script in this PR also automates the build process for a project, similar to the build.sh introduced in the main PR for ntstat, indicating a shared focus on build automation.
  • Add recipe for stxtyper v1.0.25 #51792: This PR introduces a new build.sh script for the stxtyper package, which, like the build.sh in the main PR, is designed to facilitate the build process for a software package, suggesting a commonality in the approach to build scripts.

Suggested labels

please review & merge

Suggested reviewers

  • mencian

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.

ntstat/meta.yaml Outdated
sha256: 262dc58ab6f781a6816a5d4fc129659c7fa2c3364871320eafb45bfa822fab6a

build:
noarch: generic
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
noarch: generic

This recipe builds arch specific binaries, so it is not noarch

ntstat/meta.yaml Outdated

about:
home: https://github.com/bcgsc/ntStat
license: GPL-3.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
license: GPL-3.0
license: GPL-3.0-or-later

SPDX id

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 (2)
ntstat/meta.yaml (2)

16-37: Consider adding version constraints for dependencies.

While most dependencies don't have version constraints, btllib is pinned to >=1.7.2. Consider if other dependencies (especially Python packages like matplotlib, numpy, scipy) need minimum version requirements to ensure compatibility.


39-42: Consider adding more comprehensive tests.

Current tests only verify basic command availability. Consider adding:

  • Tests for other subcommands besides 'count'
  • Tests that verify Python package imports if this provides a Python API
  • Tests with minimal example inputs if possible
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2476445 and eb9c62d.

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

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

(syntax)

🔇 Additional comments (4)
ntstat/meta.yaml (4)

1-6: LGTM!

The package metadata section follows conda recipe best practices with proper version templating.

🧰 Tools
🪛 yamllint

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

(syntax)


44-48: LGTM!

The about section is complete with all required fields and follows the SPDX license identifier format.


11-14: Verify the necessity of run_exports.

The run_exports section suggests this package provides a library that other packages might depend on. However, looking at the package description and test commands, this appears to be primarily a command-line tool. Please verify if run_exports is necessary.

#!/bin/bash
# Description: Check if package is used as a dependency by other packages
# Search for ntstat as a requirement in other recipes
echo "Checking if ntstat is used as a dependency in other recipes..."
rg -l "ntstat" --type yaml

7-9: Verify source checksum integrity.

Let's verify the provided SHA256 checksum matches the source tarball.

@bgruening bgruening merged commit 0d6fa8c into bioconda:master Nov 3, 2024
6 checks passed
@druvus
Copy link
Member

druvus commented Nov 3, 2024

@bgruening this merge should probably be reverted. The ntstat folder is not inside the recipe folder.

@bgruening
Copy link
Member

Arg, we should have a lint for this.

bgruening added a commit that referenced this pull request Nov 3, 2024
@bgruening
Copy link
Member

@xfengnefx can you please submit this again, we needed to revert this PR in #51892

druvus pushed a commit that referenced this pull request Nov 3, 2024
@parham-k
Copy link
Contributor Author

parham-k commented Nov 4, 2024

Apologies for the mistake. Submitted #51897.

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.

4 participants