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

tidk v0.2.62 #50836

Merged
merged 10 commits into from
Oct 3, 2024
Merged

tidk v0.2.62 #50836

merged 10 commits into from
Oct 3, 2024

Conversation

Euphrasiologist
Copy link
Contributor

@Euphrasiologist Euphrasiologist commented Sep 20, 2024

Update tidk to v 0.2.62.


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 tidk package to version 0.2.63 with improved installation commands.
    • Added support for the Rust compiler and OpenSSL in build requirements.
  • Bug Fixes

    • Enhanced installation output with the --verbose flag for better diagnostics.
  • Documentation

    • Simplified test commands for easier usage.

Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces updates to the tidk package, including enhancements to the build script and the meta.yaml file. The build script has been streamlined by removing outdated comments and adding an OpenSSL directory specification for the installation process. The meta.yaml file reflects a version increment, updated source URL format, modified SHA256 checksum, and changes in build and host requirements, along with simplified test commands.

Changes

File Change Summary
recipes/tidk/build.sh Removed commented-out sections and added OPENSSL_DIR=$PREFIX in the cargo install command with --verbose flag.
recipes/tidk/meta.yaml Incremented version from "0.2.41" to "0.2.63", updated source URL format, modified SHA256 checksum, added Rust compiler and OpenSSL to requirements, and simplified test commands.

Possibly related PRs

  • Add recipe for rukki v0.3.0 #51115: The build.sh script in the rukki recipe also uses the cargo install command with the --verbose flag, similar to the changes made in the main PR.

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

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

4-4: LGTM! Consider removing the --verbose flag for production builds.

The changes look good. The addition of OPENSSL_DIR=$PREFIX ensures that the correct OpenSSL library is used during the build process, which is important for consistency and reproducibility.

Consider removing the --verbose flag for production builds to reduce log output. You can keep it commented out for debugging purposes:

-C_INCLUDE_PATH=$PREFIX/include OPENSSL_DIR=$PREFIX LIBRARY_PATH=$PREFIX/lib cargo install --verbose --path . --root "${PREFIX}"
+C_INCLUDE_PATH=$PREFIX/include OPENSSL_DIR=$PREFIX LIBRARY_PATH=$PREFIX/lib cargo install --path . --root "${PREFIX}"
+# Use the following line for verbose output during debugging:
+# C_INCLUDE_PATH=$PREFIX/include OPENSSL_DIR=$PREFIX LIBRARY_PATH=$PREFIX/lib cargo install --verbose --path . --root "${PREFIX}"
recipes/tidk/meta.yaml (1)

30-30: Consider expanding test commands

The test command has been simplified to tidk -h, which might not provide comprehensive coverage of the package's functionality.

Consider expanding the test commands to ensure thorough testing of the package. A more comprehensive approach could be:

test:
  commands:
    - tidk -h
    - tidk --version
    - tidk --help

This would verify both the basic functionality and the version information, providing better assurance of the package's correct installation and operation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7cf5c0f and 87c9a4d.

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

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

(syntax)

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

1-1: LGTM: Version update

The version has been correctly updated to "0.2.62" as per the PR objectives.

🧰 Tools
🪛 yamllint

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

(syntax)


20-20: LGTM: Added Rust compiler to build requirements

The addition of the Rust compiler to the build requirements is likely necessary for the new version of the package.

Please ensure that adding the Rust compiler doesn't conflict with existing build requirements or cause any issues in the build process. You may want to test the build locally to confirm compatibility.


25-27: LGTM: Added OpenSSL to host requirements

The addition of OpenSSL to the host requirements is likely necessary for the new version of the package.

Please confirm that the addition of OpenSSL is indeed necessary for the new version and doesn't conflict with existing requirements. You may want to check the package's documentation or release notes to verify this dependency.


13-14: LGTM: Source URL and SHA256 update

The source URL has been updated to include the "v" prefix, which is a common practice. The SHA256 checksum has also been updated for the new version.

Please verify the correctness of the SHA256 checksum. You can use the following command to double-check:

Copy link
Member

@bgruening bgruening left a comment

Choose a reason for hiding this comment

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

Nice cleanup, thanks

@mbhall88
Copy link
Contributor

mbhall88 commented Oct 3, 2024

@Euphrasiologist the build seems to be failing because when the test command runs, tidk -h it can't find the database file in ~/.local/share/tidk/tidk_database.csv. This seems to be because you try and get clades before actually building the CLI https://github.com/tolkit/telomeric-identifier/blob/e62799336e6580dbb2b4fe455eb1a7f2eee2399b/src/main.rs#L7

So tidk -h will check for the existence of the database and get clades and then return the help menu. I assume this is not what you want and maybe the call to get_clades should be moved after building the CLI?

@Euphrasiologist
Copy link
Contributor Author

Thank you @mbhall88 - that was a really silly bug... I've fixed it now thank you so much!

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/tidk/meta.yaml (1)

30-30: Consider retaining both test commands for better coverage.

The test command has been simplified to tidk -h. While this checks the basic functionality, it might not be sufficient to ensure the package is working correctly. The previous version tested both the help output and the version information, which provided more comprehensive verification.

Consider updating the test commands to:

test:
  commands:
    - tidk -h
    - tidk --version

This will ensure that both the help output and version information are correctly displayed, providing better test coverage.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 87c9a4d and 8577a33.

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

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

(syntax)

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

1-1: Version update looks good.

The package version has been updated from 0.2.41 to 0.2.63, which aligns with the PR objective to update the tidk package.

🧰 Tools
🪛 yamllint

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

(syntax)


20-20: Build requirement addition looks appropriate.

The Rust compiler has been added to the build requirements, which suggests that the package now requires Rust for building. This change is likely related to updates in the package's build process or dependencies.

To confirm the necessity of Rust in the build process, let's check the package's build instructions:

Please review the output to ensure that Rust is indeed required for building the package.

✅ Verification successful

Let's correct the shell script to accurately verify the presence of Rust-related build instructions:


Rust dependency confirmed as required for build.

The Rust compiler has been added to the build requirements, and the package's README.md confirms the necessity of Rust and cargo for building the package.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for Rust-related build instructions in the package repository
curl -sL https://raw.githubusercontent.com/tolkit/telomeric-identifier/v0.2.63/README.md | grep -i 'rust\|cargo'

Length of output: 203


Script:

#!/bin/bash
# Corrected shell script to check for Rust-related build instructions in the package repository
curl -sL https://raw.githubusercontent.com/tolkit/telomeric-identifier/v0.2.63/README.md | grep -i 'rust\|cargo'

Length of output: 737


13-14: Source URL and checksum updates look correct.

The source URL format has been updated to include a "v" prefix, which likely reflects the new versioning scheme in the source repository. The SHA256 checksum has also been updated to match the new version.

To ensure the integrity of the package, let's verify the checksum:

Please compare the output of this command with the checksum in the meta.yaml file.


25-27: Host requirement addition looks appropriate.

OpenSSL has been added to the host requirements, which suggests that the package now depends on OpenSSL. This change might be related to new features or dependencies in the updated version.

To confirm the necessity of OpenSSL, let's check the package's dependencies:

Please review the output to ensure that OpenSSL is indeed required by the package.

@Euphrasiologist
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 3, 2024
@mbhall88 mbhall88 merged commit 13a52b7 into bioconda:master Oct 3, 2024
7 checks passed
@mbhall88
Copy link
Contributor

mbhall88 commented Oct 3, 2024

Ps you can remove the OpenSSL dependency by switching to the rustls-tls feature in reqwests e.g. I did this recently and made it a lot easier to build for multiple targets https://github.com/mbhall88/nohuman/blob/6578dfc5743e5d85902ff83f554dd446cc9670c6/Cargo.toml#L25

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.

4 participants