1- # Create a github action that runs the license check script and fails if it exits with a non-zero status
1+ # Automatically fix license files on PRs that need updates
2+ # Tries to auto-commit the fix, or comments with instructions if push fails
23
34name : License Check
4- on : [push, pull_request]
5+ on :
6+ pull_request :
7+ branches :
8+ - main # Only run when PR targets main
9+ paths :
10+ - " **.go"
11+ - go.mod
12+ - go.sum
13+ - " .github/licenses.tmpl"
14+ - " script/licenses*"
15+ - " third-party-licenses.*.md"
16+ - " third-party/**"
517permissions :
6- contents : read
18+ contents : write
19+ pull-requests : write
720
821jobs :
922 license-check :
@@ -12,10 +25,85 @@ jobs:
1225 steps :
1326 - name : Check out code
1427 uses : actions/checkout@v6
28+ with :
29+ ref : ${{ github.head_ref }}
1530
1631 - name : Set up Go
1732 uses : actions/setup-go@v6
1833 with :
1934 go-version-file : " go.mod"
20- - name : check licenses
21- run : ./script/licenses-check
35+
36+ # actions/setup-go does not setup the installed toolchain to be preferred over the system install,
37+ # which causes go-licenses to raise "Package ... does not have module info" errors.
38+ # For more information, https://github.com/google/go-licenses/issues/244#issuecomment-1885098633
39+ - name : Regenerate licenses
40+ env :
41+ CI : " true"
42+ run : |
43+ export GOROOT=$(go env GOROOT)
44+ export PATH=${GOROOT}/bin:$PATH
45+ ./script/licenses
46+
47+ name : Check for changes
48+ id : changes
49+ continue-on-error : true
50+ run : script/licenses-check
51+
52+ - name : Commit and push fixes
53+ if : steps.changes.outcome == 'failure'
54+ continue-on-error : true
55+ id : push
56+ run : |
57+ git config user.name "github-actions[bot]"
58+ git config user.email "github-actions[bot]@users.noreply.github.com"
59+ git add third-party-licenses.*.md third-party/
60+ git commit -m "chore: regenerate license files" -m "Auto-generated by license-check workflow"
61+ git push
62+
63+ name : Check if already commented
64+ if : steps.changes.outcome == 'failure' && steps.push.outcome == 'failure'
65+ id : check_comment
66+ uses : actions/github-script@v7
67+ with :
68+ script : |
69+ const { data: comments } = await github.rest.issues.listComments({
70+ owner: context.repo.owner,
71+ repo: context.repo.repo,
72+ issue_number: context.issue.number
73+ });
74+
75+ const alreadyCommented = comments.some(comment =>
76+ comment.user.login === 'github-actions[bot]' &&
77+ comment.body.includes('## ⚠️ License files need updating')
78+ );
79+
80+ core.setOutput('already_commented', alreadyCommented ? 'true' : 'false');
81+
82+ name : Comment with instructions if cannot push
83+ if : steps.changes.outcome == 'failure' && steps.push.outcome == 'failure' && steps.check_comment.outputs.already_commented == 'false'
84+ uses : actions/github-script@v7
85+ with :
86+ script : |
87+ await github.rest.issues.createComment({
88+ owner: context.repo.owner,
89+ repo: context.repo.repo,
90+ issue_number: context.issue.number,
91+ body: `## ⚠️ License files need updating
92+
93+ The license files are out of date. I tried to fix them automatically but don't have permission to push to this branch.
94+
95+ **Please run:**
96+ \`\`\`bash
97+ script/licenses
98+ git add third-party-licenses.*.md third-party/
99+ git commit -m "chore: regenerate license files"
100+ git push
101+ \`\`\`
102+
103+ Alternatively, enable "Allow edits by maintainers" in the PR settings so I can fix it automatically.`
104+ });
105+
106+ name : Fail check if changes needed
107+ if : steps.changes.outcome == 'failure'
108+ run : exit 1
109+
0 commit comments