Skip to content

Conversation

ps2181
Copy link
Contributor

@ps2181 ps2181 commented Jul 11, 2025

Fixes #963.

  • Added changelog.sh script to detect undocumented Python code changes.
  • Introduced a new changelog-check job in the Python - run test suite workflow.
  • The job runs on pull requests and pushes that affect python/ workflows.
  • Uses GitHub Actions annotation feature to display a warning if the changelog is missing.

@reyammer Please let me know if there are any changes needed to be made
Thanks

Copy link
Contributor

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

Choose a reason for hiding this comment

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

Summary of Changes

Hello @ps2181, 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 introduces a new automated check to improve documentation consistency for Python code. It provides a script that, when integrated into CI/CD, will warn developers if Python code changes are made without updating the CHANGELOG.md file.

Highlights

  • New Changelog Enforcement Script: I've added python/changelog.sh, a new bash script that identifies if any Python source files (.py) within the python/ directory have been modified without a corresponding update to python/CHANGELOG.md.
  • Automated Warning System: The script is designed to emit a GitHub Actions warning annotation if undocumented Python code changes are detected, prompting developers to update the changelog. While the workflow file itself is not part of the provided patch, the PR description indicates this script is intended to be integrated into the Python - run test suite workflow.
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 is currently in preview and 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 to provide feedback.

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.

Copy link
Contributor

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

Choose a reason for hiding this comment

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

Code Review

The pull request adds a script to detect undocumented Python code changes. To improve the script, consider using set -euo pipefail for error handling, parameterizing the target branch, and using grep -q for more efficient checks.

ps2181 and others added 3 commits October 7, 2025 20:04
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@reyammer reyammer enabled auto-merge October 7, 2025 18:32
@reyammer reyammer disabled auto-merge October 7, 2025 18:33
@reyammer reyammer merged commit 61bf438 into google:main Oct 7, 2025
81 checks passed
@reyammer
Copy link
Collaborator

reyammer commented Oct 7, 2025

Thanks for the PR and sorry for the long time in getting this merged!

@ps2181
Copy link
Contributor Author

ps2181 commented Oct 10, 2025

Thanks for merging it and looking forward for more task from you.

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.

Add "Some changes are not documented" warning for the python package in gh action

2 participants