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

recipe formatting #51165

Closed
wants to merge 2 commits into from
Closed

recipe formatting #51165

wants to merge 2 commits into from

Conversation

johanneskoester
Copy link
Contributor

Some recipe formatting to test new coderabbit settings.


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

Walkthrough

The pull request updates the meta.yaml file for the aacon package. Key changes include updating the version from "1.0" to "1.1" and specifying a new SHA256 checksum. The build section modifies the build number from 0 to 1 while maintaining the architecture independence (noarch: generic) and the run_exports directive for subpackage version pinning. The source section reflects the new version in the URL for the JAR file and updates the SHA256 checksum accordingly. The requirements section specifies a dependency on OpenJDK version 8 or higher. The test section remains unchanged, still invoking aacon --help. A significant change occurs in the about section, where the description field is reformatted into a multi-line string, providing detailed information about AACon's functionality, efficiency, and performance characteristics. The extra section remains unchanged, retaining notes about the Java program and its execution environment.

Possibly related PRs

  • update Hsdecipher des #51023: This PR updates the meta.yaml file for the hsdecipher package, including changes to the version and SHA256 checksum, similar to the version and checksum updates in the main PR for the aacon package.
  • Update Hsdecipher script #51057: This PR also updates the meta.yaml file for the hsdecipher package, modifying the version and SHA256 checksum, which aligns with the changes made in the main PR regarding versioning and checksum updates.

Suggested labels

please review & merge

Suggested reviewers

  • mencian

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 40d9bfa and fe894d8.

📒 Files selected for processing (1)
  • recipes/aacon/meta.yaml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • recipes/aacon/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: 0

🧹 Outside diff range and nitpick comments (1)
recipes/aacon/meta.yaml (1)

Line range hint 26-38: LGTM: Expanded description with a minor suggestion.

The about section has been significantly improved:

  • The description now provides detailed information about AACon's functionality and performance.
  • The multi-line string format enhances readability.

Consider adding a blank line after the opening | for better visual separation:

  description: |

    AACon is a set of tools implementing 17 different conservation scores
    ...
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between aafceed and 40d9bfa.

📒 Files selected for processing (1)
  • recipes/aacon/meta.yaml (1 hunks)
🔇 Additional comments (5)
recipes/aacon/meta.yaml (5)

Line range hint 1-2: LGTM: Version update and new SHA256 checksum.

The version has been correctly updated to "1.1" and a new SHA256 checksum has been provided. These changes are consistent with the package update.


Line range hint 9-12: LGTM: Build section configuration.

The build section is well-configured:

  • Build number is correctly set to 0 for the new version.
  • noarch: generic is appropriate for a Java-based tool.
  • The addition of run_exports is a good practice for version pinning.

Line range hint 14-16: LGTM: Source URL and checksum updated.

The source section has been correctly updated:

  • The URL now points to the new version (1.1) of the JAR file.
  • The SHA256 checksum has been updated to match the new file.

Line range hint 18-24: LGTM: Requirements and test sections.

The requirements and test sections are correctly configured:

  • The OpenJDK >=8 requirement is appropriate for this Java-based tool.
  • The test command aacon --help remains valid for the new version.

Line range hint 1-51: Overall LGTM: Successful update of AACon package to version 1.1

This update successfully upgrades the AACon package to version 1.1. Key improvements include:

  1. Version bump from 1.0 to 1.1
  2. Updated source URL and SHA256 checksum
  3. Proper build configuration with noarch: generic and run_exports
  4. Expanded and more informative package description

These changes enhance the package metadata and should improve user understanding of AACon's capabilities. The update adheres to Conda packaging best practices and Bioconda guidelines.

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.

1 participant