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

Set prerelease value when manually updated #3972

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Aug 14, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Aug 14, 2024

Walkthrough

Walkthrough

The recent updates enhance the common_update_data function in the HACS repository management system by simplifying the release fetching logic to always include pre-releases and limit results to 30 entries. Additionally, the changes improve how releases are processed, allowing better tracking of both stable and pre-release versions. Various JSON files were updated to include a new prerelease field, enriching metadata for version management and improving clarity in dependency handling.

Changes

Files Change Summary
custom_components/hacs/repositories/base.py Modified common_update_data function to hardcode prerelease=True and returnlimit=30, enhancing release filtering.
tests/snapshots/hacs-test-org/integration-basic/test_download_repository.json Added "prerelease": "3.0.0" to indicate a pre-release version.
tests/snapshots/hacs-test-org/integration-basic/test_update_repository_entity.json Introduced "prerelease": "3.0.0" for enhanced version tracking.
tests/snapshots/hacs-test-org/integration-basic/test_update_repository_websocket.json Added prerelease to improve version differentiation in repository metadata.
tests/snapshots/scripts/data/generate_category_data/integration/data.json New key "prerelease": "3.0.0" added for better version tracking.
tests/snapshots/scripts/data/generate_category_data/single/integration/hacs-test-org/integration-basic/data.json Included prerelease: "3.0.0" in manifest metadata.
tests/snapshots/scripts/data/test_generate_category_data_error_status_release/integration/404.json Updated to "prerelease": "3.0.0" from previous version.
tests/snapshots/scripts/data/test_generate_category_data_errors_release/integration/CancelledError.json Added prerelease: "3.0.0" for integration configuration clarity.
tests/snapshots/scripts/data/test_generate_category_data_errors_release/integration/TimeoutError.json Introduced prerelease key to enhance versioning details.
tests/snapshots/scripts/data/test_generate_category_data_errors_release/integration/error2.json Added "prerelease": "3.0.0" to signify pre-release version in metadata.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between b0f3220 and ce20a2d.

Files selected for processing (1)
  • custom_components/hacs/repositories/base.py (1 hunks)
Additional comments not posted (1)
custom_components/hacs/repositories/base.py (1)

1108-1108: Ensure the hardcoded parameters align with requirements.

The get_releases method is now called with hardcoded prerelease=True and returnlimit=30. Ensure these values align with the intended behavior and requirements of the system.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

custom_components/hacs/repositories/base.py Outdated Show resolved Hide resolved
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

custom_components/hacs/repositories/base.py Show resolved Hide resolved
custom_components/hacs/repositories/base.py Show resolved Hide resolved
@ludeeus ludeeus merged commit 3ed2c22 into main Aug 14, 2024
25 checks passed
@ludeeus ludeeus deleted the set-prerelease-value-on-manual branch August 14, 2024 07:29
@hacs-bot hacs-bot bot added this to the next milestone Aug 14, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant