Skip to content

Commit 9483d18

Browse files
trasktrask
committed
Add spotless autofix for PRs
1 parent 05a4eac commit 9483d18

File tree

2 files changed

+159
-0
lines changed

2 files changed

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