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 decom: add kmtricks dependancy #51386

Closed
wants to merge 3 commits into from

Conversation

maxibor
Copy link
Contributor

@maxibor maxibor commented Oct 14, 2024

After talking to the original author of decOM (@CamilaDuitama), this PR adds kmtricks dependancy to decOM.


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

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the meta.yaml file for the decOM package. It includes an increment in the build number from 0 to 1. Adjustments have been made to the entry points for the package, which now correctly map to the main functions of various modules, including decOM-aOralOut, decOM-format, decOM-LOO, decOM-CV, and decOM-MST. Each entry point points to its respective __main__ function. Additionally, the runtime requirement for dask has been updated from >=2021.12.0 to >= 2024.5.0, and a new runtime requirement, kmtricks, has been added to the run section. The indentation for some entries in the requirements section has been standardized for consistency. The test commands remain unchanged, preserving the help commands for each entry point.

Possibly related PRs

  • Update meta.yaml for spec2vec #49857: The changes in the meta.yaml file for the spec2vec package include updates to the build number and requirements, similar to the modifications made in the meta.yaml file for the decOM package in the main PR.

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 (3)
recipes/decom/meta.yaml (3)

Line range hint 18-24: New entry points look good, consider adding a comment for clarity.

The addition of new entry points for various decOM subcommands is well-structured and consistent. This change improves the package's usability by allowing direct access to different functionalities from the command line.

Consider adding a brief comment above the entry_points section to explain the purpose of these commands, for example:

  # Entry points for decOM main command and subcommands
  entry_points:
    - decOM = decOM.__main__:main
    # ... (rest of the entry points)

40-40: New kmtricks dependency added, consider specifying a version.

The addition of 'kmtricks' as a runtime requirement aligns with the PR objectives. However, to ensure long-term compatibility and reproducibility, it's recommended to specify a version or version range for this dependency.

Consider updating the requirement to include a version specification, for example:

    - kmtricks >=1.0.0,<2.0.0

Replace 1.0.0 with the minimum compatible version and adjust the upper bound as needed. This helps prevent potential issues with future incompatible versions.


Line range hint 1-67: Overall changes look good, consider updating package version in the future.

The modifications to the meta.yaml file, including the build number increment, addition of new entry points, and the new kmtricks dependency, are well-implemented and align with the PR objectives. These changes improve the package's functionality and usability.

If these changes significantly alter the package's functionality or API, consider updating the package version (currently 0.0.32) in a future PR. This would follow semantic versioning principles and clearly communicate the extent of changes to users.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b9f01ab and 5453264.

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

15-15: Build number increment looks good.

The build number has been correctly incremented from 0 to 1. This is appropriate when making changes to a package without changing its version.

@maxibor
Copy link
Contributor Author

maxibor commented Oct 18, 2024

Hey @martin-g,
Do you think re-triggering the tests would help ?
Seems like they timed out on the last run.

@martin-g
Copy link
Contributor

I doubt!
There is some problem with Azure CI. Many other recipes fail the same way...

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

Line range hint 18-23: LGTM: New entry points added correctly.

The addition of new entry points for various decOM modules (aOralOut, format, LOO, CV, MST) is correct and aligns with the PR objectives. Each entry point properly maps to the __main__:main function of its respective module.

Consider adding a blank line before and after the entry_points section for improved readability:

  noarch: python

  entry_points:
    - decOM = decOM.__main__:main
    - decOM-aOralOut = decOM.aOralOut.__main__:main
    - decOM-format = decOM.format.__main__:main
    - decOM-LOO = decOM.LOO.__main__:main
    - decOM-CV = decOM.CV.__main__:main
    - decOM-MST = decOM.MST.__main__:main

  script: "{{ PYTHON }} -m pip install . -vv"

32-32: LGTM with suggestions: Dependencies updated correctly.

The update of dask to version >= 2024.5.0 and the addition of kmtricks as a new dependency are correct and align with the PR objectives.

Consider the following suggestions:

  1. For the dask update, it might be beneficial to use the {{ pin_compatible('dask', max_pin='x.x') }} syntax to ensure compatibility with future versions while avoiding potential breaking changes:
- {{ pin_compatible('dask', min_pin='x.x', max_pin='x.x') }} >= 2024.5.0
  1. For the new kmtricks dependency, consider adding a version constraint and using pin_compatible:
- {{ pin_compatible('kmtricks', max_pin='x.x') }}
  1. As mentioned in the PR objectives, consider adding a run_exports section for kmtricks to help manage dependency versions and prevent downstream recipe issues:
build:
  run_exports:
    - {{ pin_subpackage('kmtricks', max_pin='x.x') }}

These changes will help ensure better version management and compatibility across the ecosystem.

Also applies to: 40-40

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between eb3b079 and 73aebfc.

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

15-15: LGTM: Build number increment is correct.

Incrementing the build number from 0 to 1 is appropriate when making changes to the package without updating its version. This follows Conda packaging best practices.


Line range hint 1-65: Overall assessment: Changes are appropriate and align with PR objectives.

The modifications to the meta.yaml file for the decOM package are well-implemented and achieve the stated objectives of the PR. The build number increment, addition of new entry points, and updates to dependencies (particularly the addition of kmtricks) are all correct and necessary changes.

A few minor suggestions have been provided to further improve version management and compatibility:

  1. Adding blank lines around the entry_points section for better readability.
  2. Using pin_compatible for the dask dependency.
  3. Adding version constraints and using pin_compatible for the new kmtricks dependency.
  4. Considering the addition of a run_exports section for kmtricks.

These suggestions, if implemented, would enhance the robustness of the package configuration. Overall, the changes in this PR are approved and ready for merging after addressing the minor suggestions.

@mencian
Copy link
Contributor

mencian commented Nov 5, 2024

Closing in favor of #51911.

@mencian mencian closed this Nov 5, 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.

3 participants