Skip to content

Commit 68d9589

Browse files
trasktrask
committed
Add spotless autofix for PRs
1 parent 05a4eac commit 68d9589

File tree

2 files changed

+158
-0
lines changed

2 files changed

+158
-0
lines changed

‎.github/workflows/auto-spotless-part-1.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Auto spotless, part 1
2+
on:
3+
pull_request:
4+
types:
5+
- opened
6+
- synchronize
7+
8+
concurrency:
9+
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
10+
cancel-in-progress: true
11+
12+
permissions:
13+
contents: read
14+
15+
jobs:
16+
check:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
20+
21+
- name: Set up JDK for running Gradle
22+
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
23+
with:
24+
distribution: temurin
25+
java-version: 17
26+
27+
- name: Set up gradle
28+
uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1
29+
with:
30+
cache-read-only: true
31+
32+
- name: Check out PR branch
33+
env:
34+
GH_TOKEN: ${{ github.token }}
35+
run: gh pr checkout ${{ github.event.pull_request.number }}
36+
37+
- name: Spotless
38+
run: ./gradlew spotlessApply
39+
40+
- id: create-patch-file
41+
name: Create patch file
42+
run: |
43+
git diff > patch
44+
if [ -s patch ]; then
45+
echo "non-empty=true" >> "$GITHUB_OUTPUT"
46+
fi
47+
48+
- name: Upload patch file
49+
if: steps.create-patch-file.outputs.non-empty == 'true'
50+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
51+
with:
52+
path: patch
53+
name: patch-${{ github.event.pull_request.number }}

‎.github/workflows/auto-spotless-part-2.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: Auto spotless, part 2
2+
on:
3+
workflow_run:
4+
workflows:
5+
- "Auto spotless, part 1"
6+
types:
7+
- completed
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
11+
cancel-in-progress: true
12+
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
apply:
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: write
21+
pull-requests: write
22+
steps:
23+
- id: download-patch
24+
name: Download patch
25+
uses: actions/[email protected]
26+
with:
27+
# this script copied from
28+
# https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#using-data-from-the-triggering-workflow
29+
script: |
30+
let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
31+
owner: context.repo.owner,
32+
repo: context.repo.repo,
33+
run_id: context.payload.workflow_run.id
34+
});
35+
let patchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
36+
return artifact.name.startsWith("patch-")
37+
})[0];
38+
if (!patchArtifact) {
39+
core.info('No patch to apply.');
40+
return;
41+
}
42+
let download = await github.rest.actions.downloadArtifact({
43+
owner: context.repo.owner,
44+
repo: context.repo.repo,
45+
artifact_id: patchArtifact.id,
46+
archive_format: 'zip'
47+
});
48+
const fs = require('fs');
49+
const path = require('path');
50+
const temp = '${{ runner.temp }}/artifacts';
51+
if (!fs.existsSync(temp)){
52+
fs.mkdirSync(temp);
53+
}
54+
fs.writeFileSync(path.join(temp, 'patch.zip'), Buffer.from(download.data));
55+
core.setOutput("exists", "true");
56+
core.setOutput("pr-number", patchArtifact.name.substring("patch-".length));
57+
58+
- name: Unzip patch
59+
if: steps.download-patch.outputs.exists == 'true'
60+
run: unzip patch.zip -d "${{ runner.temp }}/artifacts"
61+
62+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
63+
if: steps.download-patch.outputs.exists == 'true'
64+
65+
- name: Check out PR branch
66+
if: steps.download-patch.outputs.exists == 'true'
67+
env:
68+
GH_TOKEN: ${{ github.token }}
69+
run: gh pr checkout ${{ steps.download-patch.outputs.pr-number }}
70+
71+
- name: Use CLA approved github bot
72+
if: steps.download-patch.outputs.exists == 'true'
73+
# IMPORTANT do not call the .github/scripts/use-cla-approved-bot.sh
74+
# since that script could have been compromised in the PR branch
75+
run: |
76+
git config user.name otelbot
77+
git config user.email [email protected]
78+
79+
- uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
80+
if: steps.download-patch.outputs.exists == 'true'
81+
id: otelbot-token
82+
with:
83+
app-id: ${{ vars.OTELBOT_APP_ID }}
84+
private-key: ${{ secrets.OTELBOT_PRIVATE_KEY }}
85+
86+
- name: Apply patch and push
87+
if: steps.download-patch.outputs.exists == 'true'
88+
env:
89+
GH_TOKEN: ${{ steps.otelbot-token.outputs.token }}
90+
run: |
91+
git apply "${{ runner.temp }}/artifacts/patch"
92+
git commit -a -m "./gradlew spotlessApply"
93+
git push
94+
95+
- if: steps.download-patch.outputs.exists == 'true' && success()
96+
env:
97+
GH_TOKEN: ${{ steps.otelbot-token.outputs.token }}
98+
run: |
99+
gh pr comment ${{ steps.download-patch.outputs.pr-number }} --body "🔧 The result from \`./gradlew spotlessApply\` was committed to the PR branch."
100+
101+
- if: steps.download-patch.outputs.exists == 'true' && failure()
102+
env:
103+
GH_TOKEN: ${{ steps.otelbot-token.outputs.token }}
104+
run: |
105+
gh pr comment ${{ steps.download-patch.outputs.pr-number }} --body "❌ The result from \`./gradlew spotlessApply\` could not be committed to the PR branch, see logs: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID."

0 commit comments

Comments
 (0)