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

Xiangyang1984 patch 11 #51393

Closed

Conversation

Xiangyang1984
Copy link
Member

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

Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the build.sh and meta.yaml files for the pneumo-typer package. In build.sh, a command to list all files in the current directory has been added, and the source directory variable $SRC_DIR is now utilized for copying files to the target directory ${RM_DIR}. A new executable, update_mlstdb_cgmlstdb.pl, is created in the ${PREFIX}/bin directory, with permissions set to executable. The meta.yaml file has been updated to reflect a version increment from "1.0.1" to "1.0.2," along with a new SHA256 checksum and a modified source URL. The build number has been increased from 1 to 2. Additionally, dependencies on perl-gd and perl-svg have been updated to specify minimum versions, and a new test command has been added. The summary and documentation URL in the about section have also been revised for clarity and detail.

Possibly related PRs

  • add pneumo-typer recipes #51358: This PR adds new recipes for the pneumo-typer package, which includes updates to the build.sh and meta.yaml files that are directly related to the changes made in the main PR.
  • Xiangyang1984 patch 10 #51382: This PR is a patch for the pneumo-typer package that includes similar updates to the build.sh and meta.yaml files, reinforcing the changes made in the main PR.

Suggested labels

please review & merge

Suggested reviewers

  • martin-g

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fd61bf2 and 7d3a373.

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

7-7: Consider using ls -a only in debug mode.

The addition of ls -a is helpful for debugging, but it may not be necessary for every build. Consider wrapping this command in a conditional statement that checks for a debug flag or environment variable.

Example implementation:

if [ "${DEBUG:-false}" = "true" ]; then
    ls -a
fi
recipes/pneumo-typer/meta.yaml (1)

12-12: Minor: Remove trailing spaces.

There are trailing spaces on this line. While they don'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 as follows:

-    sha256: {{ sha256 }}
+    sha256: {{ sha256 }}
🧰 Tools
🪛 yamllint

[error] 12-12: 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 9b25c3e and fd61bf2.

📒 Files selected for processing (2)
  • recipes/pneumo-typer/build.sh (2 hunks)
  • recipes/pneumo-typer/meta.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint
recipes/pneumo-typer/meta.yaml

[error] 12-12: trailing spaces

(trailing-spaces)

🔇 Additional comments (9)
recipes/pneumo-typer/build.sh (3)

8-8: Excellent use of $SRC_DIR variable.

The modification to use $SRC_DIR instead of a hardcoded directory is a significant improvement. This change makes the script more robust and portable, ensuring it works correctly regardless of the build environment.


24-24: Correct permission set for new executable.

The addition of the chmod command for update_mlstdb_cgmlstdb is correct and necessary. It ensures that the new script has the proper executable permissions, consistent with the pneumo-typer script.


17-21: New executable added for update_mlstdb_cgmlstdb.pl.

The addition of a new executable for update_mlstdb_cgmlstdb.pl is consistent with the existing structure. This is a good practice for maintaining uniformity in the package.

To ensure the new script exists, please run the following verification:

recipes/pneumo-typer/meta.yaml (6)

2-3: LGTM: Version and checksum update.

The version bump to 1.0.2 and the corresponding SHA256 checksum update are consistent with the package update.


24-26: LGTM: Dependency version specifications added.

Adding minimum version requirements for perl-gd (>=2.74) and perl-svg (>=2.87) is a good practice. It helps ensure compatibility and reproducibility of the build environment.


39-39: LGTM: New test command added.

The addition of the test command update_mlstdb_cgmlstdb -h is a good practice. It helps ensure that the new executable is properly installed and accessible.


44-45: LGTM: Improved package description.

The updated summary and new description provide more detailed information about Pneumo-Typer's capabilities and requirements. This improvement in documentation is beneficial for users.


46-46: LGTM: Documentation URL added.

The addition of the documentation URL pointing to the GitHub repository is helpful. It provides users with a reliable source for more detailed information about the tool.


10-11: Verify the updated source URL.

The source URL has been updated to use the 'gz' directory instead of 'temp_dir'. This change might indicate a more permanent location for the package.

Please run the following script to verify the accessibility and correctness of the new URL:

@@ -12,7 +11,7 @@ source:
sha256: {{ sha256 }}

build:
number: 1
number: 2
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

Query: Build number decrease.

The build number has been decreased from 3 to 2. Typically, the build number should be reset to 0 when the version is bumped, or incremented if there are changes without a version bump.

Could you please clarify the reason for decreasing the build number? If this was unintentional, consider updating it to:

  number: 0

@innovate-invent
Copy link
Contributor

Can someone please block this user from submitting PRs until they provide a written response to the feedback and respect the written guidelines.

Related #51364 (comment)
and #51382 (comment)

@matthdsm
Copy link
Contributor

Stop spamming bioconda/all!

@wdecoster
Copy link
Contributor

@Xiangyang1984 Stop doing this. You are annoying all of us.

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.

6 participants