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 Saccharis #51314

Merged
merged 57 commits into from
Oct 11, 2024
Merged

Update Saccharis #51314

merged 57 commits into from
Oct 11, 2024

Conversation

AlexSCFraser
Copy link
Contributor

Add bugfix for installation issues.


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

AlexSCFraser and others added 30 commits June 13, 2023 14:33
… sha256 hash, and added --single-version-externally-managed --record=record.txt args to setup.py install as per bioconda test suite
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the meta.yaml file for the SACCHARIS package. The version number is updated to "2.0.1.dev21", and the hash value is changed to a new SHA256 hash. The original source URL is commented out and replaced with a new URL pointing to the specific versioned package file "saccharis-2.0.1.dev21_2.tar.gz". In the build section, the build number is updated from 0 to 2, and a comment is added regarding the preservation of the egg directory due to entry point-related build errors. Two entry points are updated: saccharis.show_family_categories is changed to cli_show_categories, and saccharis.update_db is modified to cli_update_hmms. In the test section, several commands are altered to include the --help flag to prevent file write permission issues during testing. Lastly, the description field in the about section is reformatted for improved readability.

Possibly related PRs

  • Update Hsdecipher #51093: This PR updates the meta.yaml file for the HSDecipher package, which is relevant due to the similar nature of changes made to the meta.yaml file in the main PR for the SACCHARIS package, including updates to version numbers and SHA256 checksums.

Suggested labels

please review & merge

Suggested reviewers

  • gbayarri

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 52e9f1b and cc77e98.

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

11-13: Consider using a more flexible URL format

The change to use a specific version in the URL is good for reproducibility. However, it may make future updates more challenging. Consider using a templated URL like the original, but with the correct file name format:

url: https://github.com/saccharis/SACCHARIS_2/releases/download/v{{ version }}/saccharis-{{ version }}_1.tar.gz

This would maintain flexibility while still pointing to the correct file.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2f495a5 and c57c8da.

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

2-3: LGTM: Version and hash updates

The version has been updated to a development release (2.0.1.dev21), and the hash value has been correspondingly updated. These changes are consistent with updating the package source.


28-28: LGTM: Updated entry points

The entry points for show_family_categories and update_db have been updated to reflect changes in the package's internal structure or naming conventions. These changes are consistent with the package update.

Also applies to: 31-31


76-82: Excellent: Improved test commands

The test commands have been updated to use the --help flag. This is a great improvement as it:

  1. Prevents file write permission issues during testing.
  2. Ensures that the commands are available and can display their help information.
  3. Speeds up the testing process by not executing the full command functionality.

This change aligns well with best practices for Conda recipe testing.


87-88: LGTM: Improved description formatting

The package description has been split into two lines, improving readability without changing the content. This is a minor but welcome improvement to the recipe's formatting.


Line range hint 1-88: Request: Clarification on bugfix

The PR objectives mention a bugfix for installation issues, but there's no explicit mention of this in the recipe changes. Could you please provide more information about the specific installation issues that were addressed? This would help in understanding how the changes in this recipe relate to the bugfix.

🧰 Tools
🪛 yamllint

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

(syntax)

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 (2)
recipes/saccharis/meta.yaml (2)

11-12: Consider using a more flexible URL format.

While the new URL is more specific, which is good for reproducibility, it hardcodes the version number. This might make future updates more error-prone. Consider using a format that still uses the {{ version }} variable:

url: https://github.com/saccharis/SACCHARIS_2/releases/download/v{{ version }}/saccharis-{{ version }}_2.tar.gz

This way, you only need to update the version number at the top of the file for future releases.


35-37: Approve build requirements, but fix indentation.

Adding build requirements for Python and setuptools is good practice and ensures the correct build environment. However, the indentation seems to be incorrect.

Please adjust the indentation to 4 spaces to match the rest of the file:

build:
    - python
    - setuptools
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a23dbf5 and 52e9f1b.

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

1-3: LGTM: Version and hash updates are consistent with the PR objective.

The version update to "2.0.1.dev21" aligns with the PR's goal of adding a bugfix. The hash value has been appropriately updated to match the new source file.

🧰 Tools
🪛 yamllint

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

(syntax)


17-17: Clarify the build number increment.

The build number has been increased from 0 to 2, which is correct when making changes to the package without changing the upstream version. However, jumping from 0 to 2 might indicate a missed intermediate build. Could you please clarify if there was an intermediate build or if this is intentional?


27-27: LGTM: Entry point updates appear consistent.

The changes to the entry points for saccharis.show_family_categories and saccharis.update_db seem to reflect updates in the package's internal structure or naming conventions. These changes appear consistent with the package's naming scheme.

To ensure these changes are correct, please verify that these new entry points exist in the package code and function as expected.

Also applies to: 30-30


77-84: LGTM: Test command updates improve testing robustness.

The addition of --help to these test commands is a good practice. It prevents file write permission issues during testing and aligns with the comment about piping test output to null. These changes will make the package testing more robust and less likely to fail due to environment-specific issues.


89-90: LGTM: Description formatting improves readability.

Splitting the description into two lines improves readability without altering the content. The line break is placed at a logical point in the sentence, making it easier to read in the YAML format.


Line range hint 1-90: Overall, the changes look good with some minor suggestions for improvement.

The updates to the SACCHARIS package recipe generally align with the PR objective of adding a bugfix. The version update, hash change, build number increment, and test command modifications all contribute to improving the package's functionality and testing robustness.

Here's a summary of the main points and recommendations:

  1. The version and hash updates are appropriate.
  2. Consider using a more flexible URL format that still includes the {{ version }} variable for easier future updates.
  3. Clarify the reason for jumping from build number 0 to 2.
  4. The entry point updates appear consistent, but verify they match the package code.
  5. Fix the indentation for the newly added build requirements.
  6. The test command updates and description formatting changes are improvements.

After addressing these minor points, the recipe should be in good shape for merging.

🧰 Tools
🪛 yamllint

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

(syntax)

@AlexSCFraser
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 11, 2024
@bgruening bgruening merged commit c03836c into bioconda:master Oct 11, 2024
7 checks passed
@bgruening
Copy link
Member

Thanks @AlexSCFraser

@coderabbitai coderabbitai bot mentioned this pull request Oct 17, 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