-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Hopla: bump pandoc #50978
Hopla: bump pandoc #50978
Conversation
Bump pandoc dependency to fix memory leak issue
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces three modifications to the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 Files selected for processing (1)
- recipes/hopla/meta.yaml (2 hunks)
🔇 Additional comments (2)
recipes/hopla/meta.yaml (2)
13-13
: Build number increment looks good.Incrementing the build number from 0 to 1 is correct when updating the recipe without changing the package version. This change follows best practices for Conda packaging.
Line range hint
1-42
: Overall recipe structure and content look good.The recipe follows Conda packaging best practices:
- Proper use of Jinja2 variables for version and hash.
- Correct specification of package metadata, source, and requirements.
- Appropriate use of 'noarch: generic' for an R package.
- Correct license specification.
- Inclusion of a basic test command.
No additional issues or improvements are identified beyond the changes made.
Note: The
run_exports
section mentioned in the PR objectives is not present in this recipe. This is typically used for compiled libraries to ensure ABI compatibility. For an R package like this, it's generally not necessary.
No artifacts found on the most recent builds. Either the builds failed, the artifacts have been removed due to age, or the recipe was blacklisted/skipped. |
There was a problem hiding this 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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- recipes/hopla/meta.yaml (2 hunks)
🔇 Additional comments (1)
recipes/hopla/meta.yaml (1)
13-13
: Build number increment looks good.Incrementing the build number is the correct approach when updating a package without changing its version. This change follows Conda packaging best practices.
recipes/hopla/meta.yaml
Outdated
run_exports: | ||
- {{ pin_subpackage("myrecipe", max_pin="x") }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarification needed on run_exports addition.
The addition of run_exports
is generally beneficial for maintaining compatibility with downstream recipes. However, there are some concerns with the current implementation:
- The package name is "hopla", but the
run_exports
refers to "myrecipe". - The use of "myrecipe" seems like a placeholder and may not be intentional.
- The PR objectives don't mention anything about adding
run_exports
.
Please clarify:
- Is the addition of
run_exports
intentional for this PR? - If yes, should it be
{{ pin_subpackage("hopla", max_pin="x") }}
instead of{{ pin_subpackage("myrecipe", max_pin="x") }}
? - If this is unintended, please remove the
run_exports
section.
@@ -26,7 +28,7 @@ requirements: | |||
- bioconductor-genomicranges >=1.42.0 | |||
- bioconductor-dnacopy >=1.64.0 | |||
- merlin 1.1.2.* # [not osx] | |||
- pandoc >=2.* | |||
- pandoc >=3.1.5 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
Pandoc version update introduces compatibility issues with certain recipes.
The update of pandoc to >=3.1.5
may cause compatibility problems with other recipes in the Bioconda ecosystem. Specifically, recipes/r-shinyngs/meta.yaml
specifies pandoc <2.19
, which conflicts with the new version requirement.
🔗 Analysis chain
Pandoc version update addresses memory leak but may cause compatibility issues.
Updating pandoc to >=3.1.5
aligns with the PR objective of addressing a memory leak issue. However, this update may introduce compatibility issues with other recipes in the Bioconda ecosystem.
A previous analysis identified at least one recipe (recipes/r-shinyngs/meta.yaml
) that specifies pandoc <2.19
. Let's verify if this is still the case and check for any other potential conflicts:
Please review the results of this script and consider the following options:
- If there are no conflicts, proceed with the update.
- If conflicts exist, consider:
a. Updating the conflicting recipes to be compatible with pandoc 3.1.5+
b. Using a more conservative version range that addresses the memory leak while maintaining compatibility (e.g.,>=2.19,<3
)
c. Discussing with the maintainers of affected packages to find a solution that works for all parties.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for other recipes that depend on pandoc and their version requirements
# Search for pandoc dependencies in other recipe files
rg --type yaml 'pandoc' recipes/ | grep -v 'recipes/hopla/meta.yaml'
Length of output: 2247
No artifacts found on the most recent builds. Either the builds failed, the artifacts have been removed due to age, or the recipe was blacklisted/skipped. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No artifacts found on the most recent builds. Either the builds failed, the artifacts have been removed due to age, or the recipe was blacklisted/skipped. |
Bump pandoc dependency to fix memory leak issue
Describe your pull request here
Please read the guidelines for Bioconda recipes before opening a pull request (PR).
General instructions
@BiocondaBot please add label
command.@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:with
...
being one of:{{ pin_subpackage("myrecipe", max_pin="x") }}
{{ pin_subpackage("myrecipe", max_pin="x.x") }}
{{ pin_subpackage("myrecipe", max_pin="x.x") }}
(in such a case, please add a note that shortly mentions your evidence for that){{ pin_subpackage("myrecipe", max_pin="x.x.x") }}
(in such a case, please add a note that shortly mentions your evidence for that){{ pin_subpackage("myrecipe", max_pin=None) }}
while replacing
"myrecipe"
with eithername
if aname|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
@BiocondaBot please add label
please review & merge
label.@BiocondaBot please fetch artifacts
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
pandoc
dependency to require version 3.1.5 or higher, ensuring compatibility with the latest features and improvements.hopla
subpackage should be pinned with a maximum version constraint.hopla
recipe.