Skip to content

feat: migrate to GitHub native release notes#297

Merged
namastex888 merged 2 commits into
devfrom
feat/github-native-release-notes
Dec 6, 2025
Merged

feat: migrate to GitHub native release notes#297
namastex888 merged 2 commits into
devfrom
feat/github-native-release-notes

Conversation

@namastex888

Copy link
Copy Markdown
Contributor

Summary

  • Add .github/release.yml for auto-generated release notes from merged PRs
  • Remove custom generateChangelog() function from unified-release.cjs
  • Remove body_path: .release-notes.md from release workflow
  • Now using GitHub's native generate_release_notes: true

Benefits

  • PR-based changelog with contributor attribution
  • Automatic issue/PR linking
  • Label-based categorization (Features, Bug Fixes, Breaking Changes, Dependencies)
  • No custom script maintenance

Test Plan

  • Merge this PR
  • Create a test release to verify auto-generated notes work correctly

- 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)
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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

  • Migration to GitHub Native Release Notes: The project now utilizes GitHub's built-in feature for automatically generating release notes, replacing a custom script.
  • Removal of Custom Changelog Script: The generateChangelog() function and related logic in unified-release.cjs have been removed, simplifying the release process.
  • New Release Notes Configuration: A .github/release.yml file has been added to configure how GitHub categorizes and formats the auto-generated release notes based on PR labels and authors.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/release.yml
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .github/release.yml Outdated
Comment on lines +12 to +13
- dependabot
- dependabot[bot]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

@namastex888
namastex888 merged commit 5c5c0d1 into dev Dec 6, 2025
1 check failed
@namastex888
namastex888 deleted the feat/github-native-release-notes branch December 6, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant