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

Make a new trim-galore build #51563

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Make a new trim-galore build #51563

merged 2 commits into from
Oct 22, 2024

Conversation

pinin4fjords
Copy link
Contributor

I'm mostly just after a new build in the biocontainer so it has a newer cutdapt, which have ARM compatibility in more recent conda versions.


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

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the meta.yaml file for the trim-galore package. The version of the package is updated to "0.6.10", and the SHA256 checksum is specified. The build section has been revised, changing the build number from 0 to 1 and adding a run_exports entry that pins the subpackage "trim-galore" with a maximum pinning of "x". The source section retains the same URL for the package source, but the indentation for the sha256 line has been corrected. The requirements section remains unchanged, listing dependencies for both build and runtime. The test section includes a command to verify the installation of trim_galore. The about section, which provides metadata about the package, including its home URL, license information, and a summary, has not been modified. The extra section, containing identifiers relevant to the package, also remains unchanged.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • rpetit3

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 26dc84d and 246c14f.

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

🧹 Outside diff range and nitpick comments (2)
recipes/trim-galore/meta.yaml (2)

Line range hint 17-21: Consider adding version constraints for dependencies.

While the dependencies are listed correctly, there are no version constraints specified, particularly for cutadapt. The PR objective mentions incorporating a newer version of cutadapt with ARM compatibility. To ensure this, consider adding a minimum version constraint for cutadapt.

Example:

  run:
    - perl
    - fastqc
    - cutadapt >=3.0  # Adjust this version as needed for ARM compatibility

Additionally, consider adding version constraints for perl and fastqc to ensure compatibility and reproducibility.


Line range hint 23-25: Consider enhancing the test command.

The current test command verifies that trim_galore is installed and produces help output. While this is a good basic check, consider adding more comprehensive tests to ensure functionality. For example:

test:
  commands:
    - trim_galore --version
    - trim_galore --help | grep trim_galore > /dev/null
    - trim_galore --help | grep cutadapt > /dev/null  # Ensure cutadapt is mentioned in the help output

This would verify the version, basic help output, and the integration with cutadapt.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c17ec86 and 26dc84d.

📒 Files selected for processing (1)
  • recipes/trim-galore/meta.yaml (1 hunks)
🧰 Additional context used
🔇 Additional comments (3)
recipes/trim-galore/meta.yaml (3)

13-13: Build number increment looks good.

The build number has been correctly incremented from 0 to 1, which is appropriate when updating a package. This change aligns with the PR objective to create a new build.


Line range hint 27-40: Metadata looks good.

The about and extra sections provide comprehensive metadata for the package, including the home URL, license information, summary, and relevant identifiers. This information appears to be complete and accurate.


Line range hint 1-2: Verify SHA256 checksum for the new version.

The version has been updated to 0.6.10, which aligns with the PR objective. Please ensure that the provided SHA256 checksum is correct for this new version.

To verify the checksum, you can run the following command:

Please compare the output with the checksum in the recipe to ensure they match.

Comment on lines 12 to 15
build:
number: 0
number: 1
noarch: generic

Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding a run_exports section.

To better manage dependencies and prevent potential API, ABI, and CLI breakage issues, consider adding a run_exports section to the build section. This would ensure that the dependency versions used at build time are recorded and locked. For example:

build:
  number: 1
  noarch: generic
  run_exports:
    - {{ pin_subpackage('trim-galore', max_pin='x.x') }}

This addition aligns with the PR objectives and Bioconda best practices.

@pinin4fjords pinin4fjords enabled auto-merge (squash) October 22, 2024 17:05
@pinin4fjords pinin4fjords merged commit 2c8094b into master Oct 22, 2024
7 checks passed
@pinin4fjords pinin4fjords deleted the new_trimgalore_build branch October 22, 2024 17:31
This was referenced Nov 2, 2024
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