Document GitHub Actions PR creation permission requirement for release workflow #113

Copilot · 2026-01-16T17:52:15Z

Release workflow fails with "GitHub Actions is not permitted to create or approve pull requests" because the repository setting is disabled.

Changes

Created documentation:

.github/FOR_ADMINS.md - 2-minute action plan for org owners with security context
.github/RELEASE_CHECKLIST.md - Setup checklist with workflow diagram
.github/RELEASE_SETUP.md - Detailed troubleshooting guide with URL templates

Updated existing files:

.github/workflows/release.yml - Inline setup comments
.github/WORKFLOWS.md - Required settings section
README.md - Maintainer instructions

Required Action

Organization owner must enable at both levels:

Org: https://github.com/organizations/{ORG}/settings/actions
Repo: https://github.com/{ORG}/{REPO}/settings/actions

Check: ☑ Allow GitHub Actions to create and approve pull requests

Context

GitHub introduced this setting in May 2022 to prevent recursive workflow executions. It's safe to enable:

PRs still require manual review/merge
Branch protection rules remain enforced
Token scope limited to explicit workflow permissions

Original prompt

引用: https://github.com/objectstack-ai/objectql/actions/runs/21075340633/job/60615659715#step:8:1

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…sions Co-authored-by: huangyiirene <[email protected]>

Co-authored-by: huangyiirene <[email protected]>

github-actions · 2026-01-17T00:53:42Z

📋 Changelog Preview

The following changes will be included in the next release:

[email protected] changeset /home/runner/work/objectql/objectql
changeset status --verbose

🦋 �[31merror�[39m Error: Failed to find where HEAD diverged from "main". Does "main" exist and it's synced with remote?
🦋 �[31merror�[39m at getDivergedCommit (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets [email protected]/node_modules/@changesets/git/dist/changesets-git.cjs.js:63:11)
🦋 �[31merror�[39m at async getChangedFilesSince (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets [email protected]/node_modules/@changesets/git/dist/changesets-git.cjs.js:189:22)
🦋 �[31merror�[39m at async Object.getChangedPackagesSinceRef (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets [email protected]/node_modules/@changesets/git/dist/changesets-git.cjs.js:229:24)
🦋 �[31merror�[39m at async getVersionableChangedPackages (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets+cli@2.29.8_@types [email protected]/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:230:27)
🦋 �[31merror�[39m at async status (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets+cli@2.29.8_@types [email protected]/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:1051:27)
🦋 �[31merror�[39m at async run (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets+cli@2.29.8_@types [email protected]/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:1355:11)
ELIFECYCLE Command failed with exit code 1.

Copilot

Pull request overview

This PR adds comprehensive documentation to resolve GitHub Actions workflow failures when attempting to create pull requests. The release workflow was failing because the required repository and organization settings weren't enabled to allow GitHub Actions to create PRs.

Changes:

Created three new documentation files providing setup instructions at different levels of detail (admin quick-start, checklist, and detailed guide)
Updated existing documentation and workflow files with inline comments and cross-references to the new guides
Added maintainer instructions to the main README

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`.github/FOR_ADMINS.md`	Quick 2-minute action plan for organization owners with security context and step-by-step instructions
`.github/RELEASE_CHECKLIST.md`	Setup checklist with workflow diagram and troubleshooting section
`.github/RELEASE_SETUP.md`	Comprehensive troubleshooting guide with URL templates and security considerations
`.github/workflows/release.yml`	Added inline comments documenting the required permission settings
`.github/WORKFLOWS.md`	Added "Required Repository Settings" section with links to setup guides
`README.md`	Added "For Repository Maintainers" section with release process setup and changeset instructions

Copilot · 2026-01-17T00:58:30Z

.github/FOR_ADMINS.md

+## Questions?
+
+**Documentation**:
+- Quick Setup: [.github/RELEASE_CHECKLIST.md](.github/RELEASE_CHECKLIST.md)


The relative path in the link is incorrect. The file is located at RELEASE_CHECKLIST.md in the same directory, not .github/RELEASE_CHECKLIST.md. The correct link should be [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md).

Suggested change

- Quick Setup: [.github/RELEASE_CHECKLIST.md](.github/RELEASE_CHECKLIST.md)

- Quick Setup: [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md)

Copilot · 2026-01-17T00:58:31Z

.github/FOR_ADMINS.md

+
+**Documentation**:
+- Quick Setup: [.github/RELEASE_CHECKLIST.md](.github/RELEASE_CHECKLIST.md)
+- Detailed Guide: [.github/RELEASE_SETUP.md](.github/RELEASE_SETUP.md)


The relative path in the link is incorrect. The file is located at RELEASE_SETUP.md in the same directory, not .github/RELEASE_SETUP.md. The correct link should be [RELEASE_SETUP.md](RELEASE_SETUP.md).

Suggested change

- Detailed Guide: [.github/RELEASE_SETUP.md](.github/RELEASE_SETUP.md)

- Detailed Guide: [RELEASE_SETUP.md](RELEASE_SETUP.md)

github-actions · 2026-01-17T01:01:07Z

📋 Changelog Preview

The following changes will be included in the next release:

[email protected] changeset /home/runner/work/objectql/objectql
changeset status --verbose

🦋 �[31merror�[39m Error: Failed to find where HEAD diverged from "main". Does "main" exist and it's synced with remote?
🦋 �[31merror�[39m at getDivergedCommit (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets [email protected]/node_modules/@changesets/git/dist/changesets-git.cjs.js:63:11)
🦋 �[31merror�[39m at async getChangedFilesSince (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets [email protected]/node_modules/@changesets/git/dist/changesets-git.cjs.js:189:22)
🦋 �[31merror�[39m at async Object.getChangedPackagesSinceRef (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets [email protected]/node_modules/@changesets/git/dist/changesets-git.cjs.js:229:24)
🦋 �[31merror�[39m at async getVersionableChangedPackages (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets+cli@2.29.8_@types [email protected]/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:230:27)
🦋 �[31merror�[39m at async status (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets+cli@2.29.8_@types [email protected]/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:1051:27)
🦋 �[31merror�[39m at async run (/home/runner/work/objectql/objectql/node_modules/.pnpm/@changesets+cli@2.29.8_@types [email protected]/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:1355:11)
ELIFECYCLE Command failed with exit code 1.

Initial plan

c692c2a

Copilot AI assigned Copilot and huangyiirene Jan 16, 2026

Copilot started work on behalf of huangyiirene January 16, 2026 17:52 View session

Copilot AI and others added 4 commits January 16, 2026 17:56

Add documentation and instructions for fixing release workflow permis…

645e907

…sions Co-authored-by: huangyiirene <[email protected]>

Add quick setup checklist for release workflow

2c8c755

Co-authored-by: huangyiirene <[email protected]>

Update documentation dates to specific format

bf3321c

Co-authored-by: huangyiirene <[email protected]>

Add admin-focused guide for enabling release workflow

51f7a3e

Co-authored-by: huangyiirene <[email protected]>

Copilot AI changed the title ~~[WIP] Update ObjectQL action job settings~~ Document GitHub Actions PR creation permission requirement for release workflow Jan 16, 2026

Copilot AI requested a review from huangyiirene January 16, 2026 18:03

Copilot finished work on behalf of huangyiirene January 16, 2026 18:03

github-actions bot added 🔧 tooling 📚 documentation size/S labels Jan 17, 2026

hotlong marked this pull request as ready for review January 17, 2026 00:56

Copilot AI review requested due to automatic review settings January 17, 2026 00:56

Copilot started reviewing on behalf of hotlong January 17, 2026 00:56 View session

Copilot AI reviewed Jan 17, 2026

View reviewed changes

删除 README.md

3b3bc7d

hotlong closed this Jan 17, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Document GitHub Actions PR creation permission requirement for release workflow #113

Document GitHub Actions PR creation permission requirement for release workflow #113

Uh oh!

Copilot AI commented Jan 16, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 17, 2026

Uh oh!

Copilot AI Jan 17, 2026

Uh oh!

github-actions bot commented Jan 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- Quick Setup: [.github/RELEASE_CHECKLIST.md](.github/RELEASE_CHECKLIST.md)
	- Quick Setup: [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md)

	- Detailed Guide: [.github/RELEASE_SETUP.md](.github/RELEASE_SETUP.md)
	- Detailed Guide: [RELEASE_SETUP.md](RELEASE_SETUP.md)

Document GitHub Actions PR creation permission requirement for release workflow #113

Document GitHub Actions PR creation permission requirement for release workflow #113

Uh oh!

Conversation

Copilot AI commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Required Action

Context

Uh oh!

github-actions bot commented Jan 17, 2026

📋 Changelog Preview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 17, 2026

📋 Changelog Preview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 16, 2026 •

edited

Loading