-
Notifications
You must be signed in to change notification settings - Fork 168
Add spotless auto-fix for PRs #1890
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| name: Auto spotless apply | ||
| on: | ||
| workflow_run: | ||
| workflows: | ||
| - "Auto spotless check" | ||
| types: | ||
| - completed | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| apply: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| steps: | ||
| - id: download-patch | ||
| name: Download patch | ||
| uses: actions/[email protected] | ||
| with: | ||
| # this script copied from | ||
| # https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#using-data-from-the-triggering-workflow | ||
| script: | | ||
| let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| run_id: context.payload.workflow_run.id | ||
| }); | ||
| let patchArtifact = allArtifacts.data.artifacts.filter((artifact) => { | ||
| return artifact.name == "patch" | ||
| })[0]; | ||
| if (!patchArtifact) { | ||
| core.info('No patch to apply.'); | ||
| return; | ||
| } | ||
| let download = await github.rest.actions.downloadArtifact({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| artifact_id: patchArtifact.id, | ||
| archive_format: 'zip' | ||
| }); | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const temp = '${{ runner.temp }}/artifacts'; | ||
| if (!fs.existsSync(temp)){ | ||
| fs.mkdirSync(temp); | ||
| } | ||
| fs.writeFileSync(path.join(temp, 'patch.zip'), Buffer.from(download.data)); | ||
| core.setOutput("exists", "true"); | ||
|
|
||
| - id: get-pr-number | ||
| name: Get PR number | ||
| uses: actions/[email protected] | ||
| with: | ||
| script: | | ||
| const response = await github.request(context.payload.workflow_run.url); | ||
| core.setOutput('pr-number', response.data.pull_requests[0].number); | ||
|
|
||
| - name: Unzip patch | ||
| if: steps.download-patch.outputs.exists == 'true' | ||
| working-directory: ${{ runner.temp }}/artifacts | ||
| run: unzip patch.zip | ||
|
|
||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
| if: steps.download-patch.outputs.exists == 'true' | ||
|
|
||
| - name: Check out PR branch | ||
| if: steps.download-patch.outputs.exists == 'true' | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| run: gh pr checkout ${{ steps.get-pr-number.outputs.pr-number }} | ||
|
|
||
| - name: Use CLA approved github bot | ||
| if: steps.download-patch.outputs.exists == 'true' | ||
| # IMPORTANT do not call the .github/scripts/use-cla-approved-bot.sh | ||
| # since that script could have been compromised in the PR branch | ||
| run: | | ||
| git config user.name otelbot | ||
| git config user.email [email protected] | ||
|
|
||
| - uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6 | ||
| if: steps.download-patch.outputs.exists == 'true' | ||
| id: otelbot-token | ||
| with: | ||
| app-id: ${{ vars.OTELBOT_APP_ID }} | ||
| private-key: ${{ secrets.OTELBOT_PRIVATE_KEY }} | ||
|
|
||
| - name: Apply patch and push | ||
| if: steps.download-patch.outputs.exists == 'true' | ||
| env: | ||
| GH_TOKEN: ${{ steps.otelbot-token.outputs.token }} | ||
| run: | | ||
| git apply "${{ runner.temp }}/artifacts/patch" | ||
| git commit -a -m "./gradlew spotlessApply" | ||
| git push | ||
|
|
||
| - if: steps.download-patch.outputs.exists == 'true' && success() | ||
| env: | ||
| GH_TOKEN: ${{ steps.otelbot-token.outputs.token }} | ||
| run: | | ||
| gh pr comment ${{ steps.get-pr-number.outputs.pr-number }} --body "🔧 The result from spotlessApply was committed to the PR branch." | ||
|
|
||
| - if: steps.download-patch.outputs.exists == 'true' && failure() | ||
| env: | ||
| GH_TOKEN: ${{ steps.otelbot-token.outputs.token }} | ||
| run: | | ||
| gh pr comment ${{ steps.get-pr-number.outputs.pr-number }} --body "❌ The result from spotlessApply could not be committed to the PR branch, see logs: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID." | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| name: Auto spotless check | ||
| on: | ||
| pull_request: | ||
| types: | ||
| - opened | ||
| - synchronize | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Set up JDK for running Gradle | ||
| uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 | ||
| with: | ||
| distribution: temurin | ||
| java-version: 17 | ||
|
|
||
| - name: Set up gradle | ||
| uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1 | ||
| with: | ||
| cache-read-only: true | ||
|
|
||
| - name: Check out PR branch | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| run: gh pr checkout ${{ github.event.pull_request.number }} | ||
|
|
||
| - name: Spotless | ||
| run: ./gradlew spotlessApply | ||
|
Comment on lines
+37
to
+38
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: the workflow called There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yeah, it's named more for what you see in the github U/X, I'll probably make it all more generic and rename things again later Spotless Check runs on PRs, generates the patch file, then Spotless Apply runs afterwards and applies the patch file |
||
|
|
||
| - id: create-patch-file | ||
| name: Create patch file | ||
| run: | | ||
| git diff > patch | ||
| if [ -s patch ]; then | ||
| echo "non-empty=true" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| - name: Upload patch file | ||
| if: steps.create-patch-file.outputs.non-empty == 'true' | ||
| uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 | ||
| with: | ||
| path: patch | ||
| name: patch | ||
Uh oh!
There was an error while loading. Please reload this page.