-
Notifications
You must be signed in to change notification settings - Fork 144
feat(ci): create in place formatting workflow for composable steps #1656
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @galesky-a, 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, reusable GitHub Action designed to standardize Java code formatting across the repository. By creating a composite action that runs Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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 introduces a new composite GitHub Action for formatting Java code using mvn spotless:apply. My review focuses on improving the action's robustness and maintainability by aligning the Java version with the project's configuration, simplifying the caching mechanism using setup-java's built-in features, and updating to a non-deprecated Java distribution. These changes will make the action more reliable and easier to maintain.
| - name: Set up JDK 20 for formatting | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| java-version: '20' | ||
| distribution: 'adopt' | ||
|
|
||
| - name: Cache Maven packages | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.m2 | ||
| key: ${{ runner.os }}-m2-${{ hashFiles(format('{0}/**/pom.xml', inputs.path)) }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-m2- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section can be simplified and improved.
- JDK Version: The
pom.xmlfor this repository specifies Java 11. It's best practice to align the JDK version in the CI with the project's version to avoid potential inconsistencies. - Maven Caching: The
actions/setup-javaaction has built-in caching for Maven, which is simpler and the recommended approach. This removes the need for a separateactions/cachestep. By usingcache-dependency-path, we can scope the cache to the specificpom.xmlfiles relevant to the path, just like in the original implementation. - Java Distribution: The
adoptdistribution is deprecated inactions/setup-java@v4. It's recommended to usetemurininstead.
You can combine setting up Java and caching into a single, updated step.
- name: Set up JDK 11 for formatting
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'temurin'
cache: 'maven'
cache-dependency-path: '${{ inputs.path }}/**/pom.xml'
Description