-
Notifications
You must be signed in to change notification settings - Fork 0
feat: check actions PR settings in repo maintenance #867
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
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
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,89 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const { execFileSync } = require('child_process'); | ||
|
|
||
| const repoPath = path.resolve(__dirname, '..'); | ||
|
|
||
| function readRepoFile(relativePath) { | ||
| return fs.readFileSync(path.join(repoPath, relativePath), 'utf8'); | ||
| } | ||
|
|
||
| function runActionsPrSettingsScript(workflowSettings) { | ||
| const contextDir = path.join(repoPath, '.context'); | ||
| fs.mkdirSync(contextDir, { recursive: true }); | ||
| const tempRoot = fs.mkdtempSync(path.join(contextDir, 'actions-pr-settings-test-')); | ||
|
|
||
| try { | ||
| const binDir = path.join(tempRoot, 'bin'); | ||
| fs.mkdirSync(binDir, { recursive: true }); | ||
| const ghPath = path.join(binDir, 'gh'); | ||
| fs.writeFileSync(ghPath, buildGhStub(workflowSettings)); | ||
| fs.chmodSync(ghPath, 0o755); | ||
|
|
||
| const scriptPath = path.join(repoPath, 'script', 'repo-maintenance.sh'); | ||
| try { | ||
| const stdout = execFileSync('bash', [scriptPath, '--check-actions-pr-settings'], { | ||
| cwd: tempRoot, | ||
| env: { ...process.env, PATH: `${binDir}:${process.env.PATH}` }, | ||
| encoding: 'utf8', | ||
| }); | ||
| return { status: 0, output: stdout }; | ||
| } catch (error) { | ||
| return { status: error.status, output: `${error.stdout || ''}${error.stderr || ''}` }; | ||
| } | ||
| } finally { | ||
| fs.rmSync(tempRoot, { recursive: true, force: true }); | ||
| } | ||
| } | ||
|
|
||
| function buildGhStub(workflowSettings) { | ||
| return [ | ||
| '#!/bin/sh', | ||
| 'if [ "$1" = "repo" ] && [ "$2" = "view" ]; then', | ||
| ' echo "owner/repo"', | ||
| ' exit 0', | ||
| 'fi', | ||
| 'if [ "$1" = "api" ]; then', | ||
| ` cat <<'JSON'\n${JSON.stringify(workflowSettings)}\nJSON`, | ||
| ' exit 0', | ||
| 'fi', | ||
| 'exit 1', | ||
| '', | ||
| ].join('\n'); | ||
| } | ||
|
|
||
| describe('repo-maintenance GitHub Actions PR creation settings', () => { | ||
| test('documents and checks repository workflow permissions needed for automated PR creation', () => { | ||
| const command = readRepoFile('.claude/commands/repo-maintenance.md'); | ||
| const script = readRepoFile('script/repo-maintenance.sh'); | ||
|
|
||
| expect(command).toContain('script/repo-maintenance.sh --check-actions-pr-settings'); | ||
| expect(command).toContain('default_workflow_permissions=write'); | ||
| expect(command).toContain('can_approve_pull_request_reviews=true'); | ||
| expect(script).toContain('check_actions_pr_creation_settings'); | ||
| expect(script).toContain('repos/$repo/actions/permissions/workflow'); | ||
| expect(script).toContain('https://github.com/$repo/settings/actions'); | ||
| }); | ||
|
|
||
| test('succeeds when Actions can create pull requests', () => { | ||
| const result = runActionsPrSettingsScript({ | ||
| default_workflow_permissions: 'write', | ||
| can_approve_pull_request_reviews: true, | ||
| }); | ||
|
|
||
| expect(result.status).toBe(0); | ||
| expect(result.output).toContain('GitHub Actions PR creation settings ok'); | ||
| }); | ||
|
|
||
| test('warns with settings URL when Actions cannot create pull requests', () => { | ||
| const result = runActionsPrSettingsScript({ | ||
| default_workflow_permissions: 'read', | ||
| can_approve_pull_request_reviews: false, | ||
| }); | ||
|
|
||
| expect(result.status).toBe(1); | ||
| expect(result.output).toContain("default workflow permissions are 'read'"); | ||
| expect(result.output).toContain('GitHub Actions PR creation is disabled'); | ||
| expect(result.output).toContain('https://github.com/owner/repo/settings/actions'); | ||
| }); | ||
| }); |
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.
When a repo keeps the default
GITHUB_TOKENsetting at read-only but grantscontents: write/pull-requests: writeon the specific PR-creating jobs, this check fails even though PR creation is configured correctly; GitHub documents that the workflow/jobpermissionskey modifies the token for that job (https://docs.github.com/en/actions/tutorials/authenticate-with-github_token#modifying-the-permissions-for-the-github_token), and this repo already does that in.github/workflows/update-libraries.yml:23-25,.github/workflows/scheduled-maintenance.yml:31-33, and.github/workflows/claude.yml:51-53. Requiring the repo-wide default to bewritemakes--check-actions-pr-settingsreject the safer read-only-default configuration and tells maintainers to broaden every workflow unnecessarily.Useful? React with 👍 / 👎.