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 piawka #51239

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Update piawka #51239

merged 1 commit into from
Oct 8, 2024

Conversation

taprs
Copy link
Contributor

@taprs taprs commented Oct 8, 2024

Updating piawka manually with some changes in the recipe and build.sh because I switched to other dependencies, thus probably more than bioconda-utils can handle. (I also could not find the config.yaml file for which I was asked by bioconda-utils autobump...)


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

The pull request introduces changes to two files within the piawka recipe. In build.sh, the verbosity setting for debugging has been removed, and the previous logic for modifying shebangs has been eliminated. The script now directly copies all scripts from the $SRC_DIR/scripts/ directory to the $PREFIX/bin/ directory and sets them as executable. In meta.yaml, the version of the piawka package has been updated from 0.7.10 to 0.8.1, along with a corresponding change in the source URL and SHA256 checksum to match the new version. The dependency on mawk has been replaced with gawk, requiring a minimum version of 5.0.0 from the conda-forge channel. Additionally, the test command has been modified to change how help information is accessed, shifting from piawka_par.sh -h to piawka --help. Overall, these changes reflect updates to the build process and package metadata.

Suggested labels

please review & merge, new version

Suggested reviewers

  • rpetit3

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

🧹 Outside diff range and nitpick comments (3)
recipes/piawka/build.sh (1)

Line range hint 1-7: Overall simplification with potential for refinement

The build script has been significantly simplified, which can make it easier to maintain. However, this simplification comes with potential risks:

  1. Lack of error checking and logging.
  2. Potential inclusion of unnecessary files.
  3. Broad application of executable permissions.

Consider implementing the following improvements:

  1. Add error checking and logging throughout the script.
  2. Implement more targeted file copying and permission setting.
  3. Reintroduce shebang modifications if necessary for cross-platform compatibility.
  4. Add comments explaining the purpose of each step in the build process.

These changes would make the script more robust, secure, and maintainable while retaining its simplicity.

recipes/piawka/meta.yaml (2)

20-20: Dependency update looks good, with a minor suggestion.

The switch from mawk to gawk aligns with the PR objectives. Using a minimum version for gawk is a good practice. However, to ensure consistency across different systems, consider pinning the major version:

- conda-forge::gawk >=5.0.0,<6

This will prevent potential issues if a major version update introduces breaking changes.


26-26: Test command update looks good, with a minor formatting issue.

The test command has been updated to reflect changes in the package's interface, which is good. However, there's a trailing space at the end of the line that should be removed.

-    - piawka --help 
+    - piawka --help

This will resolve the yamllint warning about trailing spaces.

🧰 Tools
🪛 yamllint

[error] 26-26: 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 2c62701 and 8d08b8d.

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

[error] 23-23: trailing spaces

(trailing-spaces)


[error] 26-26: trailing spaces

(trailing-spaces)

🔇 Additional comments (4)
recipes/piawka/build.sh (1)

1-2: LGTM: Shebang and directory creation are correct.

The shebang and directory creation are standard and appropriate for this type of build script.

recipes/piawka/meta.yaml (3)

2-2: Version update looks good.

The package version has been correctly updated to 0.8.1, which aligns with the PR objectives.


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

The updates to the piawka recipe, including version bump, dependency changes, and test command modifications, have been implemented correctly. A few minor suggestions have been made to improve dependency pinning and formatting. Once these small adjustments are addressed, the recipe should be ready for merging.

🧰 Tools
🪛 yamllint

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

(syntax)


10-10: SHA256 checksum update looks good.

The SHA256 checksum has been updated to match the new version's source. This is consistent with the version change.

Let's verify that the source URL has been updated correctly:

recipes/piawka/build.sh Show resolved Hide resolved
recipes/piawka/build.sh Show resolved Hide resolved
@taprs
Copy link
Contributor Author

taprs commented Oct 8, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 8, 2024
@bgruening bgruening merged commit 51def90 into bioconda:master Oct 8, 2024
7 checks passed
This was referenced Oct 22, 2024
@coderabbitai coderabbitai bot mentioned this pull request Oct 31, 2024
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.

3 participants