refactor(build): update changelog formatting in gradle task #36021
Conversation
Add documentation for the new formatChanges Gradle task that helps maintain consistent formatting in CHANGES.md. Also includes minor formatting fixes in CHANGES.md itself.
Modify the formatChanges task to standardize SDK language references in CHANGES.md by converting square brackets to parentheses for better consistency. The change specifically targets language mentions at the end of sentences or before issue references.
The change removes the conditional check for adding a blank line after the template in the formatChanges task, making it always add the blank line. This simplifies the logic while maintaining the same behavior.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @liferoad, 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 process of maintaining the project's changelog by introducing an automated formatting tool. It ensures that the CHANGES.md file adheres to a consistent structure and style, making it easier to read and update. This change improves the overall quality and readability of release notes for both developers and users.
Highlights
- Automated Changelog Formatting: Introduced a new Gradle task,
./gradlew formatChanges, to automate the formatting and standardization of theCHANGES.mdfile. - Changelog Content Standardization: The new formatting task enforces a consistent structure for
CHANGES.md, including ordering of sections (e.g., Highlights, I/Os, Bugfixes) and standardizing language tags from[Language]to(Language). - Contributor Documentation: Updated the
contributor-docs/code-change-guide.mdto inform contributors about the newformatChangestask and its benefits for maintaining a clean and consistent changelog.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
|
Assigning reviewers: R: @kennknowles added as fallback since no labels match configuration Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
| } | ||
|
|
||
| // Write formatted content back | ||
| changesFile.writeText(formattedLines.joinToString("\n")) |
There was a problem hiding this comment.
Thanks, this is a good idea. An optional suggestion: it would be great to make this a check that runs as part of the linting precommit.
To do this, we could add a conditional statement to this line based on a flag, which would fail the command if there are any diffs here (instead of just writing them).
Not blocking this PR on the suggestion, though
There was a problem hiding this comment.
Yes, that is the next item on my list.
Addresses #35760
This only adds
./gradlew formatChangesto make sure some simple rules are enforced in CHANGES.md.Next: add a github workflow to check the format for CHANGES.md.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.