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

Show all pending updates #4024

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Show all pending updates #4024

merged 1 commit into from
Sep 2, 2024

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Sep 2, 2024

Non-downloadable updates were previously hidden as updates in the HACS UI.
This was wrong. Even if you do not meet the minimum requirements for the update, it still exists and is pending.

Copy link
Contributor

coderabbitai bot commented Sep 2, 2024

Walkthrough

Walkthrough

The changes involve modifications to the pending_update logic in the base.py file, removing the conditional check for download capability. This affects how the update status is reported. Additionally, a new test suite is introduced in test_display_status.py to validate the display status of repositories, supported by a snapshot JSON file for API interaction testing.

Changes

Files Change Summary
custom_components/hacs/repositories/base.py Modified the pending_update logic to remove the check for self.can_download, affecting how update status is reported.
tests/repositories/test_display_status.py Introduced a test suite to validate the display_status of repositories under various conditions, including states for new, pending restart, and upgrades.
tests/snapshots/api-usage/tests/repositories/test_display_statustest-display-status.json Added a snapshot JSON file to support the new test suite, mapping API endpoints related to repository data for validation during tests.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between e78afd1 and 67e9948.

Files selected for processing (3)
  • custom_components/hacs/repositories/base.py (1 hunks)
  • tests/repositories/test_display_status.py (1 hunks)
  • tests/snapshots/api-usage/tests/repositories/test_display_statustest-display-status.json (1 hunks)
Additional context used
Path-based instructions (1)
tests/snapshots/api-usage/tests/repositories/test_display_statustest-display-status.json (1)

Pattern tests/**/*.json: Never suggest changes to the JSON files located under the tests directory

Additional comments not posted (3)
tests/snapshots/api-usage/tests/repositories/test_display_statustest-display-status.json (1)

1-9: LGTM!

The JSON file is a new addition located under the tests directory. It appears to be a snapshot file used for API interaction testing, specifically for the test_display_status test case in tests/repositories/test_display_status.py.

The file structure and content seem appropriate for its intended purpose. As per the additional instructions, no changes should be suggested for JSON files under the tests directory.

tests/repositories/test_display_status.py (1)

8-33: LGTM!

The test_display_status function is well-structured and covers the following display status scenarios:

  • Default status
  • New repository
  • Pending restart
  • Pending upgrade
  • Installed

The test function uses assertions to validate the expected display status for each scenario.

custom_components/hacs/repositories/base.py (1)

Line range hint 1005-1016: LGTM!

The changes to the pending_update property look good. Removing the self.can_download check aligns with the PR objective of showing all pending updates in the UI, regardless of their downloadability.

The rest of the logic remains intact, ensuring that the presence of an installed version and a selected tag is still checked.


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 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 or @coderabbitai title 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.
Early access features: disabled

We are currently testing the following features in early access:

  • Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues on the discussion post.

@ludeeus ludeeus merged commit 756d4e9 into main Sep 2, 2024
26 checks passed
@ludeeus ludeeus deleted the no-hide branch September 2, 2024 06:04
@hacs-bot hacs-bot bot added this to the next milestone Sep 2, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Sep 3, 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