-
Notifications
You must be signed in to change notification settings - Fork 28
[docs] docs: Remove bloat from permissions.md #3575
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,8 +10,10 @@ The `permissions:` section controls what GitHub API operations your workflow can | |||||
| ```yaml wrap | ||||||
| permissions: | ||||||
| contents: read | ||||||
| issues: write | ||||||
| pull-requests: write | ||||||
| actions: read | ||||||
| safe-outputs: | ||||||
| create-issue: | ||||||
| add-comment: | ||||||
| ``` | ||||||
|
|
||||||
| ## Permission Model | ||||||
|
|
@@ -20,30 +22,15 @@ permissions: | |||||
|
|
||||||
| Agentic workflows follow a principle of least privilege: | ||||||
|
|
||||||
| - **Read-only by default**: Workflows run with minimal permissions | ||||||
| - **Read-only by default**: Main job runs with minimal read permissions only | ||||||
| - **Write through safe outputs**: Write operations happen in separate jobs with sanitized content | ||||||
| - **Explicit permissions**: All permissions must be declared in frontmatter | ||||||
| - **No direct write permissions**: Use safe-outputs instead of `write` permissions in the main job | ||||||
|
||||||
| - **No direct write permissions**: Use safe-outputs instead of `write` permissions in the main job | |
| - **No direct write permissions**: Use safe outputs instead of `write` permissions in the main job |
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.
The safe-outputs configuration in the example is incomplete. Each safe output should include a max limit (e.g.,
max: 5) to demonstrate proper rate limiting configuration, consistent with the examples shown later in the document.