search

home-assistant / developers.home-assistant

Developers website for Home Assistant.
https://developers.home-assistant.io
Other
295 stars 933 forks source link

Rename Services to Service actions #2249

Closed frenck closed 2 months ago

frenck commented 2 months ago

Proposed change

SIA. For Home Assistant 2024.8, we will be phasing out the term "Services" (as in service calls) and replace it with "Actions".

This PR adjusts the developer documentation for it and adds a developer blog to inform about the change from a developer perspective.

Type of change

Additional information

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The overall change involves a comprehensive terminology update within Home Assistant, where the term "Services" is being replaced with "Actions." This semantic shift aims to clarify the meaning of service calls and improve user comprehension by aligning terminology with functionality. Although the terminology is updated, the underlying functionality remains unchanged. This change is reflected across various documentation files, UI elements, and developer references to ensure consistency and clarity throughout the platform. ## Changes | Files (Grouped by Similar Changes) | Change Summary | |---------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | blog/2024-07-15-service-actions.md, blog/2024-07-16-service-actions.md | Introduced terminology change from "Services" to "Actions" for clarity in Home Assistant service calls. | | docs/add-ons/communication.md | Updated terminology from "services" to "actions" for tasks and interactions with add-ons via `hassio.addon_stdin`. | | docs/api/native-app-integration/sending-data.md | Renamed "calling a service" to "calling a service action" to emphasize action-oriented interactions. | | docs/architecture/core.md, docs/architecture/devices-and-services.md, docs/architecture_components.md | Altered terminology to "register service actions" and clarified the role of actions in integrations and devices. | | docs/asyncio_categorizing_functions.md | Adjusted function descriptions and variable naming for automation trigger service actions. | | docs/auth_permissions.md | Clarified terminology to "service actions" and emphasized correct user context for permission checking. | | docs/core/entity/button.md, docs/core/entity/climate.md, docs/core/entity/fan.md, docs/core/entity/light.md | Refined descriptions and method names to reflect changes from "services" to "service actions." | | docs/core/entity/media-player.md | Updated terminology to "actions" for `volume_up`, `volume_down`, `announce`, and `enqueue` parameters. | | docs/core/entity/scene.md, docs/core/entity/siren.md, docs/core/entity/update.md | Updated descriptions to reflect changes from "service" to "service action" in various functionalities. | | docs/core/platform/raising_exceptions.md, docs/core/platform/repairs.md | Updated terminology from "service handlers" to "service action handlers" and clarified exception raising scenarios.| | docs/core/platform/reproduce_state.md | Updated terminology to "service actions" in the context of scenes and integrations. | | docs/creating_platform_code_review.md | Emphasized new naming convention for extra actions added by a platform using `` format. | | docs/dev_101_hass.md, docs/dev_101_services.md | Updated terminology to "registering service actions" and renamed several references and function names accordingly.| | docs/development_testing.md | Updated testing guidelines to emphasize using the core service registry for service action calls. |
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between d424dadd348958407af7e76439c732c681007004 and 2ed7d99732c0d23c29c5aff41a1cdd0854d827dc.
Files selected for processing (1) * blog/2024-07-16-service-actions.md (1 hunks)
Files skipped from review due to trivial changes (1) * blog/2024-07-16-service-actions.md
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.