Changelog #6
Changelog #6
Conversation
- Add GitHub Action to update changelog based on conventional commits - Create CONTRIBUTING.md with commit message guidelines - Add changelog section to README.md - Set up CHANGELOG.md with proper format
Summary of ChangesHello @brombomb, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request establishes a robust and automated changelog management system for the project, particularly for Home Assistant updates. It introduces a structured Highlights
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a changelog generation process based on Conventional Commits. It adds a CHANGELOG.md file, a CONTRIBUTING.md with commit guidelines, and updates the README.md to reference these new files. The changes are a great step towards automating release notes and improving contributor experience. I've provided a few suggestions to enhance consistency and fix some minor issues in the new documentation files.
| ### Added | ||
| - Initial release of TronbytAssistant integration | ||
| - Support for Tronbyt device notifications from Home Assistant | ||
| - Brightness control via light entity | ||
| - Update interval configuration via number entity | ||
| - Pinned app selection via select entity | ||
| - Night mode toggle via switch entity | ||
| - Night mode start/end time configuration | ||
| - Night mode brightness and app selection | ||
| - Dim mode start time and brightness configuration | ||
| - Built-in notification service (Push) | ||
| - Custom text notification service (Text) | ||
| - App deletion service (Delete) | ||
| - Template support for dynamic content | ||
| - Argument passing to apps | ||
| - HACS integration support | ||
| - Configuration flow for easy setup | ||
| - Multi-language support (English and German translations) | ||
|
|
||
| ### Features | ||
| - Local polling IoT class for reliable communication | ||
| - Single config entry design | ||
| - Multi-device support | ||
| - Service selectors that update automatically | ||
| - Template value support for dynamic content | ||
| - HTTP error handling and logging | ||
| - Pre-commit hooks for code quality | ||
| - Comprehensive test suite |
There was a problem hiding this comment.
The CHANGELOG.md file states it's based on Keep a Changelog, but it uses a non-standard Features section. To adhere to the standard, the items under Features should be merged into the Added section, as they represent new functionality added in that release.
### Added
- Initial release of TronbytAssistant integration
- Support for Tronbyt device notifications from Home Assistant
- Brightness control via light entity
- Update interval configuration via number entity
- Pinned app selection via select entity
- Night mode toggle via switch entity
- Night mode start/end time configuration
- Night mode brightness and app selection
- Dim mode start time and brightness configuration
- Built-in notification service (Push)
- Custom text notification service (Text)
- App deletion service (Delete)
- Template support for dynamic content
- Argument passing to apps
- HACS integration support
- Configuration flow for easy setup
- Multi-language support (English and German translations)
- Local polling IoT class for reliable communication
- Single config entry design
- Multi-device support
- Service selectors that update automatically
- Template value support for dynamic content
- HTTP error handling and logging
- Pre-commit hooks for code quality
- Comprehensive test suite|
|
||
| ## Manual Workflow Trigger | ||
|
|
||
| You can also manually trigger the changelog update by going to the Actions tab and running the "Update Changelog" workflow. No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end text files with a newline character. This prevents issues with some command-line tools and source control systems. Please add a newline at the end of this file.
| You can also manually trigger the changelog update by going to the Actions tab and running the "Update Changelog" workflow. | |
| You can also manually trigger the changelog update by going to the Actions tab and running the "Update Changelog" workflow. | |
| - Development setup | ||
| - Pull request process |
There was a problem hiding this comment.
The CONTRIBUTING.md file does not yet contain sections for 'Development setup' or 'Pull request process'. To avoid confusion for contributors, it would be best to remove these items from the list for now. They can be added back once the corresponding sections are created in CONTRIBUTING.md.
1 participant
Add a changelog generator for the HA updates.