Skip to content

update permission from caller#47

Merged
maryliag merged 1 commit into
open-telemetry:mainfrom
maryliag:exclude-bot
Jul 8, 2026
Merged

update permission from caller#47
maryliag merged 1 commit into
open-telemetry:mainfrom
maryliag:exclude-bot

Conversation

@maryliag

@maryliag maryliag commented Jul 8, 2026

Copy link
Copy Markdown
Member

Update example on readme to make it clear that the caller needs to add the permission to be able to add the comment and label

Copilot AI review requested due to automatic review settings July 8, 2026 14:15
@maryliag maryliag requested a review from a team as a code owner July 8, 2026 14:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the first-time-pr/README.md consumer documentation to make explicit that the caller workflow must grant pull-requests: write at the job level for the reusable workflow to function. Previously the examples omitted the caller-side permissions: block, which could lead adopters to hit permission failures when the label/comment steps run. I verified every technical claim against the actual reusable workflow (.github/workflows/first-time-pr.yml), which declares pull-requests: write for exactly the gh pr edit --add-label and gh pr comment steps described in the README.

Changes:

  • Added job-level permissions: pull-requests: write (and top-level permissions: {}) to both example caller snippets, with inline comments explaining why.
  • Added a new "Required permissions" section explaining that a reusable workflow's permissions are capped by the caller's grants.
  • Added a zizmor: ignore[dangerous-triggers] inline comment on the pull_request_target: trigger plus a note clarifying it only matters for repos running zizmor.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@maryliag maryliag merged commit 081f1e7 into open-telemetry:main Jul 8, 2026
5 checks passed
@maryliag maryliag deleted the exclude-bot branch July 8, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants