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 gfastats tool version #51246

Merged
merged 5 commits into from
Oct 8, 2024
Merged

Conversation

SaimMomin12
Copy link
Contributor

This PR concerns with version update of gfastats tool from 1.3.7 to 1.3.8


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

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces an update to the gfastats package's version number in the meta.yaml file. The version has been incremented from "1.3.7" to "1.3.8". This change is reflected in the version variable declaration. Additionally, the build number has been updated from 1 to 0. The git_tag in the source section has been modified to dynamically reference the updated version, changing from a static tag git_tag: v1.3.7 to git_tag: v{{ version }}. The URL format for the source has also been updated to point to a tarball of the release, changing from git_tag: v1.3.7 to url: https://github.com/vgl-hub/gfastats/archive/refs/tags/v1.3.8.tar.gz. No other structural or content changes are present in the file.

Possibly related PRs

  • 2024.4 #50977: This PR updates the version number in the meta.yaml file for the biobb_structure_checking package, similar to the version update in the main PR for the gfastats package.
  • Update slow5tools to 1.3.0 #51048: This PR also updates the version number in the meta.yaml file for the slow5tools package, reflecting a similar change as seen in the main PR.
  • updated revision and enabled osx build #51176: This PR updates the version number in the meta.yaml file for the pgrc package, aligning with the version update in the main PR.

Suggested labels

autobump, new version


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dd509ed and 6cf3d79.

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

📒 Files selected for processing (1)
  • recipes/gfastats/meta.yaml (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
recipes/gfastats/meta.yaml (2)

Line range hint 1-43: Summary of changes and next steps

The update of gfastats from version 1.3.7 to 1.3.8 looks good overall. Here's a summary of the review:

  1. The version update in line 2 is correct.
  2. The build number should be reset to 0.
  3. We need to verify that the git_tag in the source section has been updated to match the new version.

Once these points are addressed, the PR should be ready for merging.

🧰 Tools
🪛 yamllint

[error] 3-3: trailing spaces

(trailing-spaces)


[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


2-2: Verify git_tag consistency with new version.

The version has been updated correctly. Let's ensure that the git_tag in the source section has been updated to match.

Run the following script to verify the git_tag:

✅ Verification successful

git_tag is consistent with the new version

The git_tag in the source section correctly matches the new version v1.3.8.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that git_tag matches the new version

# Test: Check if git_tag is correctly set to v1.3.8
grep -n "git_tag:" recipes/gfastats/meta.yaml

Length of output: 74


Script:

#!/bin/bash
# Description: Verify that the version is correctly set to 1.3.8

grep -n 'set version =' recipes/gfastats/meta.yaml

Length of output: 82

@SaimMomin12
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 8, 2024
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/gfastats/meta.yaml (1)

3-3: Remove trailing spaces.

There are trailing spaces on this line. While this doesn't affect functionality, it's good practice to remove them for consistency and to avoid potential issues in some systems.

You can remove the trailing spaces from this line.

🧰 Tools
🪛 yamllint

[error] 3-3: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1504652 and 2242514.

📒 Files selected for processing (1)
  • recipes/gfastats/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gfastats/meta.yaml

[error] 3-3: trailing spaces

(trailing-spaces)

🔇 Additional comments (4)
recipes/gfastats/meta.yaml (4)

2-2: Version update looks good.

The version has been correctly updated from 1.3.7 to 1.3.8, which aligns with the PR objective.


13-13: Build number correctly reset.

The build number has been properly reset to 0, which is the correct practice when updating the package version. This change addresses the concern raised in the previous review.


Line range hint 1-52: Overall, the changes look good and align with the PR objectives.

The version has been correctly updated to 1.3.8, the source URL has been adjusted accordingly, and the build number has been reset to 0 as per best practices. These changes are consistent with the PR objectives and address the concerns raised in the previous review.

A few minor points to note:

  1. Please verify the SHA256 checksum as suggested earlier.
  2. Consider removing the trailing spaces on line 3 for better code hygiene.

Once these small items are addressed, the PR should be ready for merging.

🧰 Tools
🪛 yamllint

[error] 3-3: trailing spaces

(trailing-spaces)


[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


9-10: Source URL update is correct. Verify SHA256 checksum.

The source URL has been correctly updated to use the new version 1.3.8. The change from using git_tag to a direct tarball URL is valid. The SHA256 checksum has also been updated, which is necessary for the new version.

Please verify the SHA256 checksum to ensure it matches the new tarball. You can use the following command:

Compare the output with the SHA256 value in the meta.yaml file.

@bgruening
Copy link
Member

14:48:54 BIOCONDA INFO (OUT) ./include/main.h:31:10: fatal error: log.h: No such file or directory
14:48:54 BIOCONDA INFO (OUT)    31 | #include "log.h"
14:48:54 BIOCONDA INFO (OUT)       |          ^~~~~~~
14:48:54 BIOCONDA INFO (OUT) compilation terminated.

@gf777 seems that the tarball is still missing something.

@SaimMomin12 sorry for the wrong advice I was hoping the tarball works now, please revert to the git checkout.

@bgruening bgruening enabled auto-merge (squash) October 8, 2024 15:30
@SaimMomin12
Copy link
Contributor Author

Thanks @bgruening

@bgruening bgruening merged commit 77e9015 into bioconda:master Oct 8, 2024
7 checks passed
@SaimMomin12 SaimMomin12 deleted the update_gfastats branch October 9, 2024 10:02
@gf777
Copy link

gf777 commented Oct 9, 2024

I am not sure what you want to do. This version that I recently added: wget https://github.com/vgl-hub/gfastats/releases/download/v1.3.8/gfastats.v1.3.8-with_submodules.zip compiles fine as it contains the submodule as well. Looks like it may be using the wrong version?
Note that afaik there is no way to have the standard tarball include more than the source code from the repo (without the subomodules). This is created by github by default

@martin-g
Copy link
Contributor

The update looks good to me!

A recipe could get the Git submodules by using 'git_url' with a Git tag

@bgruening
Copy link
Member

@SaimMomin12 I think what happend is that you used the wrong URL, see 2242514 and https://github.com/vgl-hub/gfastats/releases/download/v1.3.8/gfastats.v1.3.8-with_submodules.zip from @gf777 ....

@SaimMomin12
Copy link
Contributor Author

@bgruening Oh no, my bad! Would it be a good idea to edit the recipe now and create a PR to correct this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants