docs: Elevate GitHub permissions to all workflow examples#46
Merged
joeltjames merged 1 commit intomainfrom Feb 25, 2026
Merged
Conversation
Add explicit pull-requests and contents permissions to all GitHub Actions workflow examples throughout the documentation. These permissions are required for the action to function properly: - pull-requests: write - Required for posting comments to PRs - contents: read - Required for reading PR data This resolves workflow failures observed in ChurchCenterApp (PR #4716) where the action failed to post comments due to missing permissions. The permissions are now prominently featured in: - README.md basic usage example - Installation guide workflow - Your First Rule guide - All example workflows (6 examples) - Migration guide examples (4 workflows) - Documentation homepage Fixes failures like: planningcenter/ChurchCenterApp#4716 See: https://github.com/planningcenter/ChurchCenterApp/actions/runs/21845368960
Member
Author
|
I did this all with Copilot in a codespace. I don't know why it didn't co-author! |
joeltjames
approved these changes
Feb 25, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add explicit pull-requests and contents permissions to all GitHub Actions workflow examples throughout the documentation.
Problem
The action was failing in downstream projects (e.g., ChurchCenterApp) when trying to post comments to PRs because the necessary GitHub permissions were not explicitly configured in the workflow examples.
See: https://github.com/planningcenter/ChurchCenterApp/actions/runs/21845368960/job/63039860783
Related PR: https://github.com/planningcenter/ChurchCenterApp/pull/4716
Solution
Added the required permissions block to all workflow examples:
Changes
These permissions are now prominently featured across all documentation to prevent similar issues in the future.