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 nf-core - Add missing linkify dependency #51762

Merged
merged 4 commits into from
Oct 29, 2024

Conversation

pmoris
Copy link
Contributor

@pmoris pmoris commented Oct 29, 2024

The bioconda version of nf-core tools produced errors when running commands that launched the trogon TUI. The reason was the missing package linkify,
which gets pulled in as a dependency of textual in the PyPi build, but not in the conda-forge recipe.
See https://github.com/Textualize/textual/blob/22770300252deb28d266fe4ed4766d6e2a2f5dd2/pyproject.toml#L44, https://github.com/conda-forge/textual-feedstock/blob/main/recipe/meta.yaml and nf-core/tools#3257.


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

Warning

Rate limit exceeded

@mencian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 53 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between caf6a23 and ce2d870.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the meta.yaml file for the nf-core package by updating the build number from 0 to 1. Additionally, it introduces a new dependency, linkify-it-py, to the run requirements section, specifying a version constraint of >=1,<3. No other changes to the structure, logic, or error handling of the file are present in this diff.

Possibly related PRs

  • Update nf-core to 3.0.0 #51249: This PR updates the meta.yaml file for the nf-core package, which is directly related to the main PR that also modifies the meta.yaml file for the same package by updating the build number and adding a new dependency.
  • Update nf-core to 3.0.1 #51272: This PR continues the updates for the nf-core package, incrementing the version and adding a new dependency, which aligns with the changes made in the main PR regarding dependency management.
  • Update nf-core to 3.0.2 #51333: This PR further updates the nf-core package, indicating ongoing modifications to the meta.yaml file, which is relevant to the changes made in the main PR.

Suggested labels

please review & merge

Suggested reviewers

  • martin-g
  • adamhospital

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 f83e9c7 and f507ea8.

📒 Files selected for processing (1)
  • recipes/nf-core/meta.yaml (1 hunks)
🔇 Additional comments (1)
recipes/nf-core/meta.yaml (1)

53-53: Implementation correctly addresses the reported TUI errors.

The addition of linkify-it-py as a runtime dependency aligns with the PR objectives and should resolve the TUI errors in the bioconda version of nf-core tools. The package's use of run_exports ensures API/ABI compatibility is maintained.

@@ -50,6 +50,7 @@ requirements:
- ruamel.yaml
- tabulate
- textual ==0.71.0
- linkify-it-py
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

Add version constraint >=2.0.0 to linkify-it-py dependency

The textual package version 0.71.0 depends on markdown-it-py[linkify]>=2.1.0, which in turn requires linkify-it-py>=2.0.0. To ensure compatibility, please update the dependency line to:

    - linkify-it-py >=2.0.0
🔗 Analysis chain

Consider adding version constraints for linkify-it-py.

While adding the dependency is correct, it's recommended to specify version constraints to ensure compatibility with textual 0.71.0 and prevent potential future issues.

Let's verify the required version:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check textual's dependencies to determine the required linkify-it-py version

# Test: Search for linkify-it-py in textual's pyproject.toml or setup.py
rg -A 5 'linkify-it-py' 

# Fallback: Check if there's a requirements.txt
fd -g 'requirements*.txt' -x cat {} \; | rg 'linkify-it-py'

Length of output: 321


Script:

#!/bin/bash
# Let's try to find any version constraints or usage of linkify-it-py in the codebase
# First, check if there's a pyproject.toml or setup.py
fd -g 'pyproject.toml|setup.py' -x cat {} \; | rg -i 'linkify|dependencies'

# Also check for any imports or direct usage
rg -l 'import.*linkify|from.*linkify' 

# Let's also check if there are any version constraints in other meta.yaml files
fd -g 'meta.yaml' -x cat {} \; | rg -A 2 -B 2 'linkify-it-py'

Length of output: 279


Script:

#!/bin/bash
# Let's check the textual package's dependencies directly from PyPI
# Using curl to fetch the PyPI API data for textual version 0.71.0
curl -s https://pypi.org/pypi/textual/0.71.0/json | jq -r '.info.requires_dist[] | select(contains("linkify"))'

# Also check the latest version constraints from other packages that use linkify-it-py
curl -s https://pypi.org/pypi/linkify-it-py/json | jq -r '.info.version'

Length of output: 231

@pmoris
Copy link
Contributor Author

pmoris commented Oct 29, 2024

A double check on this would be nice. I think coderabbitai got confused:

Textual 0.71.0 (which nf-core pins) indeeds depends on markdown-it-py[linkify]>=2.1.0:

└─▶ curl -s https://pypi.org/pypi/textual/0.71.0/json | jq -r '.info.requires_dist[] | select(contains("linkify"))'
markdown-it-py[linkify,plugins]>=2.1.0

However, it then suggests that markdown-it-py>=2.1.0 depends on linkify-it-py>=2.0.0, which doesn't seem to be the case:

└─▶ curl -s https://pypi.org/pypi/markdown-it-py/2.1.0/json | jq -r '.info.requires_dist[] | select(contains("linkify"))'
linkify-it-py~=1.0 ; extra == "linkify"

└─▶ curl -s https://pypi.org/pypi/markdown-it-py/3.0.0/json | jq -r '.info.requires_dist[] | select(contains("linkify"))'
linkify-it-py>=1,<3 ; extra == "linkify"

I think pinning linkify to >=1<3 instead is the right call here?

The bioconda version of nf-core tools produced errors
when running commands that launched the trogon TUI.
The reason was the missing package linkify,
which gets pulled in as a dependency of textual in the PyPi
build, but not in the conda-forge recipe.
See https://github.com/Textualize/textual/blob/22770300252deb28d266fe4ed4766d6e2a2f5dd2/pyproject.toml#L44,
https://github.com/conda-forge/textual-feedstock/blob/main/recipe/meta.yaml
and nf-core/tools#3257.
@pmoris pmoris force-pushed the nf-core-dependency-fix branch from f507ea8 to 33f9654 Compare October 29, 2024 11:16
Code Rabbit AI suggestion:
The textual package version 0.71.0 depends on
markdown-it-py[linkify]>=2.1.0, which in turn
requires linkify-it-py>=2.0.0.

However, checking the actual dependencies of
markdown-it-py, it seems it wants linkify-it-py
to be >=1,<3.
pmoris added a commit to pmoris/tools that referenced this pull request Oct 29, 2024
Code Rabbit AI suggestion:
The textual package version 0.71.0 depends on
markdown-it-py[linkify]>=2.1.0, which in turn
requires linkify-it-py>=2.0.0.

However, checking the actual dependencies of
markdown-it-py, it seems it wants linkify-it-py
to be >=1,<3.

See bioconda/bioconda-recipes#51762
@mencian mencian merged commit f388436 into bioconda:master Oct 29, 2024
6 checks passed
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.

2 participants