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

Hopla: bump pandoc #50978

Merged
merged 3 commits into from
Sep 26, 2024
Merged

Hopla: bump pandoc #50978

merged 3 commits into from
Sep 26, 2024

Conversation

matthdsm
Copy link
Contributor

@matthdsm matthdsm commented Sep 26, 2024

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

  • 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 the pandoc dependency to require version 3.1.5 or higher, ensuring compatibility with the latest features and improvements.
    • Added a new entry to specify that the hopla subpackage should be pinned with a maximum version constraint.
  • Chores
    • Incremented the build number to indicate a new version of the hopla recipe.

Bump pandoc dependency to fix memory leak issue
Copy link
Contributor

coderabbitai bot commented Sep 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces three modifications to the meta.yaml file for the hopla recipe. The build number is incremented from 0 to 1, indicating a new build version. The version constraint for the pandoc dependency has been updated from >=2.* to >=3.1.5, requiring a more recent version. Additionally, a new entry under run_exports has been added to specify that the hopla subpackage should be pinned with a maximum version constraint of x.

Changes

File Change Summary
recipes/hopla/meta.yaml Build number incremented from 0 to 1; pandoc version constraint updated from >=2.* to >=3.1.5; new run export added for hopla with maximum version constraint x.

Possibly related PRs

  • 2024.4 #50977: This PR updates the meta.yaml file, which is directly related to the changes made in the main PR, specifically regarding versioning and dependency management.

Suggested reviewers

  • gbayarri

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 76f9508 and 66166c1.

📒 Files selected for processing (1)
  • recipes/hopla/meta.yaml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/hopla/meta.yaml

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 d6403ea and 421965f.

📒 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.

@BiocondaBot
Copy link
Collaborator

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.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 421965f and 76f9508.

📒 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.

Comment on lines 15 to 16
run_exports:
- {{ pin_subpackage("myrecipe", max_pin="x") }}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

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:

  1. The package name is "hopla", but the run_exports refers to "myrecipe".
  2. The use of "myrecipe" seems like a placeholder and may not be intentional.
  3. The PR objectives don't mention anything about adding run_exports.

Please clarify:

  1. Is the addition of run_exports intentional for this PR?
  2. If yes, should it be {{ pin_subpackage("hopla", max_pin="x") }} instead of {{ pin_subpackage("myrecipe", max_pin="x") }}?
  3. 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
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

⚠️ Potential issue

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:

  1. If there are no conflicts, proceed with the update.
  2. 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

@BiocondaBot
Copy link
Collaborator

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.

Copy link
Contributor

@nvnieuwk nvnieuwk left a comment

Choose a reason for hiding this comment

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

LGTM

recipes/hopla/meta.yaml Outdated Show resolved Hide resolved
@BiocondaBot
Copy link
Collaborator

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.

@matthdsm matthdsm merged commit 6ffd645 into master Sep 26, 2024
7 checks passed
@matthdsm matthdsm deleted the patch/hopla-pandoc branch September 26, 2024 13:52
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