-
Notifications
You must be signed in to change notification settings - Fork 5
Run OpenRewriteRecipeBestPractices on pull requests
#92
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Description: This workflow is triggered when the `receive-pr` workflow completes to post suggestions on the PR. | ||
| # Since this pull request has write permissions on the target repo, we should **NOT** execute any untrusted code. | ||
| # https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ | ||
| --- | ||
| name: comment-pr | ||
|
|
||
| on: | ||
| workflow_run: | ||
| workflows: ["receive-pr"] | ||
| types: | ||
| - completed | ||
|
|
||
| jobs: | ||
| post-suggestions: | ||
| # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-a-workflow-based-on-the-conclusion-of-another-workflow | ||
| if: ${{ github.event.workflow_run.conclusion == 'success' }} | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| pull-requests: write | ||
| env: | ||
| # https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token | ||
| ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{github.event.workflow_run.head_branch}} | ||
| repository: ${{github.event.workflow_run.head_repository.full_name}} | ||
|
|
||
| # Download the patch | ||
| - uses: actions/download-artifact@v4 | ||
| with: | ||
| name: patch | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| run-id: ${{ github.event.workflow_run.id }} | ||
| - name: Apply patch | ||
| run: | | ||
| git apply git-diff.patch --allow-empty | ||
| rm git-diff.patch | ||
|
|
||
| # Download the PR number | ||
| - uses: actions/download-artifact@v4 | ||
| with: | ||
| name: pr_number | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| run-id: ${{ github.event.workflow_run.id }} | ||
| - name: Read pr_number.txt | ||
| run: | | ||
| PR_NUMBER=$(cat pr_number.txt) | ||
| echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV | ||
| rm pr_number.txt | ||
|
|
||
| # Post suggestions as a comment on the PR | ||
| - uses: googleapis/code-suggester@v4 | ||
| with: | ||
| command: review | ||
| pull_number: ${{ env.PR_NUMBER }} | ||
| git_dir: '.' | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Description: This workflow runs OpenRewrite recipes against opened pull request and upload the patch. | ||
| # Since this pull request receives untrusted code, we should **NOT** have any secrets in the environment. | ||
| # https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ | ||
| --- | ||
| name: receive-pr | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize] | ||
| branches: | ||
| - main | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| env: | ||
| MAVEN_OPTS: -Xmx8g | ||
| GRADLE_OPTS: -Dorg.gradle.jvmargs='-Xmx8g' | ||
|
|
||
| jobs: | ||
| upload-patch: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{github.event.pull_request.head.ref}} | ||
| repository: ${{github.event.pull_request.head.repo.full_name}} | ||
| - name: Set up JDK 17 | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| distribution: temurin | ||
| java-version: 17 | ||
| cache: 'maven' | ||
|
|
||
| # Capture the PR number | ||
| # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#using-data-from-the-triggering-workflow | ||
| - name: Create pr_number.txt | ||
| run: echo "${{ github.event.number }}" > pr_number.txt | ||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: pr_number | ||
| path: pr_number.txt | ||
| - name: Remove pr_number.txt | ||
| run: rm -f pr_number.txt | ||
|
|
||
| # Execute recipes | ||
| - name: Apply OpenRewrite recipes | ||
| run: | | ||
| mvn --batch-mode \ | ||
| checkstyle:check -Dcheckstyle.failOnViolation=false \ | ||
| rewrite:run -Drewrite.activeRecipes=org.checkstyle.recipes.OpenRewriteRecipeBestPractices | ||
|
|
||
| # Capture the diff | ||
| - name: Create patch | ||
| run: | | ||
| git diff | tee git-diff.patch | ||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: patch | ||
| path: git-diff.patch |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
@timtebeek , do you have visual examples in web on how this workflow works?
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.
Yes sure! The blog above links to this pull request that has a few of such resolved comments
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 approach if very noisy, we tried it with Sonar, long time ago, it produce too much comments, and PRs started to load slow and we need to close PR and open it again. When you have pre-junior contributors as majority in projects, this is not very good approach. Just failed CI and contributors open failed job to see suggestions is better.
in slow traffic project and experienced contributors it will work.
we can try it in this project and see how it will go.
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.
Yes I find it works best when the suggestions are immediately applied, but I do like how contextualized they are and that they don't break flow ideally: just press a button and move on. I hope that'll be your experience as well.