CI: rework caching and build/test environment #29
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 @Harvester57, 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 significantly refactors the Continuous Integration (CI) setup for Python projects, focusing on how Poetry is installed and how project dependencies are cached. The changes aim to streamline the build and test environment by leveraging more integrated and efficient GitHub Actions features, leading to a more robust and potentially faster CI pipeline for Python-based repositories.
Highlights
- CI Environment Setup: The CI setup action (
common-setup) has been updated to usepipxfor Poetry installation, replacing the previously usedabatilo/actions-poetryaction. This change streamlines the Poetry setup process. - Dependency Caching Optimization: Dependency caching for Poetry projects now leverages the built-in
cache: poetryfeature ofactions/setup-python. This eliminates the need for a separateactions/cachestep dedicated to Poetry dependencies, simplifying the workflow and potentially improving cache hit rates. - Explicit Poetry Environment Management: An explicit step
poetry env use ${{ inputs.python_version }}has been added. This ensures that Poetry correctly identifies and utilizes the specified Python version for the project's virtual environment, enhancing consistency across CI runs. - Configurable Poetry Version: A new input
poetry_versionhas been introduced to thecommon-setupaction, allowing the specific version of Poetry to be installed to be configured externally. The default version is set to2.1.3.
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 or fill out our survey 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
-
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 refactors the CI setup to use the built-in caching capabilities of the actions/setup-python action for Poetry, which simplifies the workflow. However, a critical issue exists where the Install dependencies step refers to a now-deleted caching step, which will cause the CI to fail.
|
/gemini review |
There was a problem hiding this comment.
Code Review
The pull request refactors the CI setup to use the built-in caching from actions/setup-python for Poetry, which is a great improvement for simplicity and maintainability. I've found a critical issue where the script for setting the shell doesn't account for macOS runners, which will cause CI failures on that platform. I've also suggested simplifying the dependency installation steps, as the current two-step process is unnecessarily complex with the new caching mechanism.
| # Install dependencies. `--no-root` means "install all dependencies but not the project | ||
| # itself", which is what you want to avoid caching _your_ code. The `if` statement | ||
| # ensures this only runs on a cache miss. | ||
| - name: Install dependencies | ||
| run: poetry install --no-interaction --no-root | ||
| shell: ${{ env.shellos }} | ||
| if: steps.setup-python.outputs.cache-hit != 'true' | ||
|
|
||
| - name: Install project | ||
| run: poetry install --no-interaction | ||
| shell: ${{ env.shellos }} | ||
| - name: Install project | ||
| run: poetry install --no-interaction | ||
| shell: ${{ env.shellos }} |
There was a problem hiding this comment.
The two-step installation process for dependencies and the project can be simplified. The comment mentions avoiding caching your code, but when using cache: poetry with actions/setup-python, the entire virtual environment is cached at the end of the job. This includes the project installed in editable mode. Therefore, the distinction of using --no-root is no longer providing the intended benefit.
A single poetry install step is sufficient and simpler. Poetry is idempotent and will handle both cache-hit and cache-miss scenarios efficiently. On a cache hit, it will quickly verify dependencies and install the project.
- name: Install project and dependencies
run: poetry install --no-interaction
shell: ${{ env.shellos }}
|
/gemini review |
There was a problem hiding this comment.
Code Review
The code changes introduce improvements to the CI setup by leveraging the built-in Poetry caching mechanism. Review comments include suggestions to standardize indentation in a shell script and add a comment to clarify the purpose of the final poetry install step.
No description provided.