Add blog post about core config move

emontnemery commented 4 weeks ago

Proposed change

Type of change

[ ] Document existing features within Home Assistant
[x] Document new or changing features which there is an existing pull request elsewhere
[ ] Spelling or grammatical corrections, or rewording for improved clarity
[ ] Changes to the backend of this documentation
[ ] Removed stale or deprecated documentation

Additional information

This PR fixes or closes issue: fixes #
Link to relevant existing code or pull request: https://github.com/home-assistant/core/pull/129163

Summary by CodeRabbit

Documentation
- Updated guidance for custom integrations regarding the relocation of the core configuration class.
- Provided examples for correcting type annotations in custom integrations.
Chores
- Implemented backward compatibility for existing imports with warning notifications until Home Assistant Core version 2025.11.

coderabbitai[bot] commented 4 weeks ago

📝 Walkthrough

## Walkthrough The core configuration class `Config` has been moved from `homeassistant/core.py` to `homeassistant/core_config.py`. This relocation requires custom integrations to update their import paths accordingly. Additionally, many custom integrations are noted to have incorrect type annotations for the `config` parameter in the `async_setup` function, which should use `ConfigType` instead of the `Config` instance. Backward compatibility is maintained until Home Assistant Core version 2025.11, with warnings for outdated imports. ## Changes | File Path | Change Summary | |---------------------------------------------|------------------------------------------------------------------------------------------------| | blog/2024-10-31-core-config-moved.md | Documentation of the relocation of `Config`, incorrect type annotations, and backward compatibility details. | | homeassistant/core.py | `Config` class removed; import statements updated to reflect its new location. | | homeassistant/core_config.py | `Config` class added here; serves as the new location for the core configuration class. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant CustomIntegration participant HomeAssistantCore participant CoreConfig CustomIntegration->>HomeAssistantCore: Import Config from homeassistant.core HomeAssistantCore-->>CustomIntegration: Warning for deprecated import CustomIntegration->>CoreConfig: Import Config from homeassistant.core_config CoreConfig-->>CustomIntegration: Config instance ready for use ```

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Reviewing files that changed from the base of the PR and between 7781b741cf9965e82ff2cd0774f8c37e7a065147 and 8dec1a5ea66a230c6edd0b42e664a7cef0c3ab6d.

📒 Files selected for processing (1)

* `blog/2024-10-31-core-config-moved.md` (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* blog/2024-10-31-core-config-moved.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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

MartinHjelmare commented 3 weeks ago

I think we should add a link too, per above.

home-assistant / developers.home-assistant