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

Core-next adherence #733

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Core-next adherence #733

merged 4 commits into from
Sep 26, 2024

Conversation

CoMPaTech
Copy link
Member

@CoMPaTech CoMPaTech commented Sep 26, 2024

Fixes #730

Summary by CodeRabbit

  • Bug Fixes

    • Disabled Markdown linting functionality in pre-commit hooks.
  • Improvements

    • Enhanced type checking for HVAC mode settings to ensure only valid modes are accepted.
    • Adjusted logging message format for clarity in the async_select_option method.

@CoMPaTech CoMPaTech added the core-dev-compat Home Assistant Core Release Candidate or Beta compatibility label Sep 26, 2024
@CoMPaTech CoMPaTech requested a review from a team as a code owner September 26, 2024 06:51
Copy link
Contributor

coderabbitai bot commented Sep 26, 2024

Warning

Rate limit exceeded

@bouwew has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 24 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between c898473 and 24aaa73.

Walkthrough

This pull request includes modifications to the .pre-commit-config.yaml, custom_components/plugwise/climate.py, and custom_components/plugwise/select.py files. The changes disable Markdown linting by commenting out its configuration, reorganize import statements and enforce stricter type checking for HVAC modes in the climate component, and adjust a logging statement in the select component.

Changes

File Change Summary
.pre-commit-config.yaml Commented out the repository entry for markdownlint-cli, disabling Markdown linting.
custom_components/plugwise/climate.py Moved import statement for ClimateEntity; updated async_set_hvac_mode parameter type from str to HVACMode.
custom_components/plugwise/select.py Removed a period from a logging statement in async_select_option.

Assessment against linked issues

Objective Addressed Explanation
Next Home Assistant version incompatibility (#730)

Possibly related issues

Possibly related PRs

Suggested labels

enhancement, needs_upstreaming

Poem

🐇 In the garden where code does play,
Changes bloom like flowers in May.
Markdown's linting takes a rest,
HVAC modes now pass the test.
With logs refined and imports neat,
Our integration's now more sweet! 🌼


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

@CoMPaTech
Copy link
Member Author

Not sure why markdownlint was problematic, might need to revert the disabling ... but lets wait for next core release

@CoMPaTech CoMPaTech marked this pull request as draft September 26, 2024 06:53
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)
custom_components/plugwise/climate.py (1)

Line range hint 1-324: Summary: Changes align with PR objectives

The modifications in this file, particularly the update to the async_set_hvac_mode method signature, contribute to improved type safety and align well with the PR objective of ensuring compatibility with the upcoming version of Home Assistant. These changes are part of addressing the compatibility issues mentioned in issue #730.

To further ensure the PR meets its objectives:

  1. Verify that similar type annotation updates have been made in other relevant files within the Plugwise integration.
  2. Consider adding or updating unit tests to cover the modified async_set_hvac_mode method, ensuring it handles HVACMode correctly.
  3. Update the integration's documentation if there are any changes in usage or behavior resulting from these modifications.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 93d1439 and c898473.

📒 Files selected for processing (3)
  • .pre-commit-config.yaml (1 hunks)
  • custom_components/plugwise/climate.py (2 hunks)
  • custom_components/plugwise/select.py (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • .pre-commit-config.yaml
  • custom_components/plugwise/select.py
🔇 Additional comments (2)
custom_components/plugwise/climate.py (2)

13-13: LGTM: Import reorganization.

The relocation of the ClimateEntity import improves code organization without affecting functionality.


279-279: Approve type annotation change and verify impact.

The update to use HVACMode instead of str for the hvac_mode parameter enforces stricter type checking, which is a good practice. This change aligns with the PR objective of ensuring compatibility with the upcoming version of Home Assistant.

To ensure this change doesn't break existing functionality, please run the following script to check for any occurrences where async_set_hvac_mode is called with a string argument:

If any occurrences are found, they should be updated to use HVACMode instead of a string.

@bouwew
Copy link
Contributor

bouwew commented Sep 26, 2024

@CoMPaTech Why is markdownlinting disabled?

Copy link
Contributor

@bouwew bouwew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@CoMPaTech
Copy link
Member Author

@CoMPaTech Why is markdownlinting disabled?

Irrational behavior both locally and CI - seems some issue with NPM - hence still drafted

Copy link

sonarcloud bot commented Sep 26, 2024

@bouwew bouwew marked this pull request as ready for review September 26, 2024 18:07
@bouwew bouwew merged commit b32d4a2 into main Sep 26, 2024
8 checks passed
@bouwew bouwew deleted the corenext branch September 26, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-dev-compat Home Assistant Core Release Candidate or Beta compatibility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Next Home Assistant version incompatibility
2 participants