docs: add GOTCHAS #12 — caller permissions can break reusable workflows#40
Merged
Conversation
Startup_failure with no logs can occur when caller top-level permissions don't include the scopes needed by the reusable workflow's jobs. Document the pattern + add required perms to the release_please.yaml header comment so new consumers don't hit this.
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
1 participant
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.
Summary
Document the caller-permissions cascade gotcha surfaced while rolling out release-please to a second consumer repo. Same YAML pattern that worked on one repo hit `startup_failure` with no logs on another — root cause was top-level `permissions: contents: read` being insufficient for the reusable's release job.
Changes
Test plan