feat: migrate to GitHub native release notes#297
Conversation
- Add .github/release.yml for auto-generated release notes - Remove custom generateChangelog() from unified-release.cjs - Remove body_path from release workflow (use generate_release_notes)
Summary of ChangesHello @namastex888, 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 streamlines the release process by migrating from a custom changelog generation script to GitHub's native auto-generated release notes feature. This change simplifies maintenance, leverages GitHub's built-in capabilities for categorizing changes based on PR labels, and provides automatic issue/PR linking and contributor attribution, enhancing the clarity and efficiency of release documentation. 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
|
There was a problem hiding this comment.
Code Review
This pull request is a great improvement, migrating the project to use GitHub's native auto-generated release notes. This simplifies the release tooling by removing the custom generateChangelog script and replacing it with a standard .github/release.yml configuration file. The changes are clean and well-executed. I have one suggestion regarding the release notes configuration to ensure the intended behavior for dependency updates.
| - dependabot | ||
| - dependabot[bot] |
There was a problem hiding this comment.
This configuration excludes pull requests from dependabot and dependabot[bot]. However, you also have a 'Dependencies' category, which is often used for Dependabot PRs. This means dependency updates from Dependabot will not appear in the release notes.
If you want to include these updates, I'd suggest removing these lines. If you intend to exclude them, you might also consider removing the 'Dependencies' category (lines 27-29) to avoid having an empty section in your release notes and prevent confusion.
Summary
.github/release.ymlfor auto-generated release notes from merged PRsgenerateChangelog()function fromunified-release.cjsbody_path: .release-notes.mdfrom release workflowgenerate_release_notes: trueBenefits
Test Plan