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

Rename 'service' to 'action' following Home Assistant 2024.8 #805

Merged
merged 1 commit into from
Aug 6, 2024

Conversation

frenck
Copy link
Owner

@frenck frenck commented Aug 6, 2024

Description

SSIA, Home Assistant 2024.8 will introduce "Actions" and will say goodbye to "Services". This preps Spook for that same change.

Besides all naming changes, it also will adjust for the new action: syntax (while it maintain support for the old service: syntax).

Motivation and Context

How has this been tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@frenck frenck added documentation Solely about the documentation of the project. major This PR causes a major version bump in the version number. maintenance Generic maintenance tasks. minor This PR causes a minor version bump in the version number. and removed major This PR causes a major version bump in the version number. labels Aug 6, 2024
Copy link

sonarcloud bot commented Aug 6, 2024

Copy link

coderabbitai bot commented Aug 6, 2024

Warning

Rate limit exceeded

@frenck has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 59 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 f8f0335 and 6d4ae13.

Walkthrough

Walkthrough

The recent changes throughout the Spook integration for Home Assistant introduce a significant shift in terminology from "services" to "actions." This change aims to enhance clarity and align the documentation and code with a more action-oriented framework. The updates span multiple files, including code implementations and documentation, ensuring consistent use of the new terminology while maintaining existing functionality.

Changes

Files Change Summary
custom_components/spook/.../unknown_service_references.py, custom_components/spook/services.yaml Changed terminology from "service" to "action" in logging and service descriptions for clarity.
custom_components/spook/translations/de.json, .../en.json, .../es.json, .../fr.json, .../nl.json Updated translations to reflect the change from "service" to "action," enhancing clarity and user context.
custom_components/spook/util.py Added a conditional block in async_find_services_in_sequence to track action calls.
documentation/.../_toc.yml, .../about.md, .../actions.md, .../areas.md, etc. Replaced "services" with "actions" throughout documentation files, standardizing terminology.

Poem

🐇 In the land of code where actions play,
A shift in words brightens the day!
From services to actions, oh what a cheer,
Enhancing clarity, bringing us near.
With every update, our joy does grow,
Hopping along with the new flow! 🌟


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.

@frenck frenck merged commit 250e167 into main Aug 6, 2024
19 checks passed
@frenck frenck deleted the frenck-2024-0474 branch August 6, 2024 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Solely about the documentation of the project. maintenance Generic maintenance tasks. minor This PR causes a minor version bump in the version number.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant