feat: configure release-please #74
Conversation
![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 @b-long, 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 configures the "release-please" automation tool to streamline the release process. It includes the necessary manifest file for release-please and updates the project's version number to "0.2.20" across relevant files, preparing the repository for automated versioning and changelog generation.
Highlights
- Release Automation Configuration: Introduces the configuration for "release-please", an automated release management tool, by adding the ".release-please-manifest.json" file.
- Version Number Update: Updates the project version from "0.2.19" to "0.2.20" across various configuration and build-related files, including "README.md", "pyproject.toml", and build scripts. This aligns the project with the initial version set for release-please.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request configures release-please and bumps the project version to 0.2.20 across multiple files. The changes are mostly correct for a release. However, I've identified a few areas for improvement regarding maintainability. Specifically, the build scripts use hardcoded version numbers in wheel filenames, which is brittle. I've suggested using wildcards instead. Additionally, the version number is duplicated in many files, and I've recommended consolidating it to a single source of truth to make future maintenance easier.
|
|
||
| echo "✨✨✨ Install wheel" | ||
| pip install dist/otdf_python-0.2.19-py3-none-any.whl | ||
| pip install dist/otdf_python-0.2.20-py3-none-any.whl |
There was a problem hiding this comment.
Hardcoding the version number in the wheel filename makes the build script brittle as it needs to be updated for every release. Using a wildcard (glob) to find the wheel file would make this script more robust and reduce maintenance for version bumps.
| pip install dist/otdf_python-0.2.20-py3-none-any.whl | |
| pip install dist/otdf_python-*-py3-none-any.whl |
|
|
||
| # Prove that the wheel can be installed | ||
| pip install dist/otdf_python-0.2.19-py3-none-any.whl | ||
| pip install dist/otdf_python-0.2.20-py3-none-any.whl |
There was a problem hiding this comment.
Hardcoding the version number in the wheel filename makes the build script brittle as it needs to be updated for every release. Using a wildcard (glob) to find the wheel file would make this script more robust and reduce maintenance for version bumps.
| pip install dist/otdf_python-0.2.20-py3-none-any.whl | |
| pip install dist/otdf_python-*-py3-none-any.whl |
| source "${BUILD_ROOT}/.venv-wheel/bin/activate" | ||
| pip install pybindgen | ||
| pip install dist/otdf_python-0.2.19-py3-none-any.whl | ||
| pip install dist/otdf_python-0.2.20-py3-none-any.whl |
There was a problem hiding this comment.
Hardcoding the version number in the wheel filename makes the build script brittle as it needs to be updated for every release. Using a wildcard (glob) to find the wheel file would make this script more robust and reduce maintenance for version bumps.
| pip install dist/otdf_python-0.2.20-py3-none-any.whl | |
| pip install dist/otdf_python-*-py3-none-any.whl |
| name = "otdf-python" | ||
| # Should match 'setup.py' version number (used for gopy/pybindgen) | ||
| version = "0.2.19" | ||
| version = "0.2.20" |
There was a problem hiding this comment.
The project version is duplicated across several files (pyproject.toml, setup.py, setup_ci.py, uv.lock, and hardcoded in build scripts). This increases the maintenance burden and risk of inconsistencies during version updates. It's a best practice to have a single source of truth for the version number.
Consider defining the version only in pyproject.toml and dynamically reading it in other files like setup.py. While release-please seems to be handling the updates, this change would improve the project's maintainability.
No description provided.