Skip to content

Add explicit permissions to 7 workflows#2607

Merged
pelikhan merged 4 commits intomainfrom
copilot/add-explicit-permissions-to-workflows
Oct 27, 2025
Merged

Add explicit permissions to 7 workflows#2607
pelikhan merged 4 commits intomainfrom
copilot/add-explicit-permissions-to-workflows

Conversation

Copy link
Contributor

Copilot AI commented Oct 27, 2025 •
edited
Loading

Seven workflows lacked explicit permissions: declarations, relying on GitHub Actions defaults. Analysis of workflow run #18840321667 showed permission-denied warnings in production.

Changes

Smoke test workflows (5 files) - Read-only main job pattern with PR access:

permissions:
  contents: read
  actions: read
  pull-requests: read
  • smoke-copilot.md
  • smoke-claude.md
  • smoke-codex.md
  • smoke-opencode.md
  • smoke-copilot.firewall.md

These use strict: true with safe-outputs.create-issue, so write operations happen in separate jobs. The pull-requests: read permission is required for reading merged pull requests.

Daily news workflow - Read-all permissions:

permissions: read-all
  • daily-news.md

Uses permissions: read-all to access all repository data including discussions, issues, and pull requests.

Notion workflow - Read-only analysis:

permissions:
  contents: read
  issues: read
  actions: read
  • notion-issue-summary.md

Impact

  • Explicit permission model prevents reliance on GitHub Actions defaults
  • Follows least privilege principle
  • Protects against future GitHub permission model changes
Original prompt

This section details on the original issue you should resolve

<issue_title>[q] Add explicit permissions to 7 workflows</issue_title>
<issue_description># Q Workflow Optimization Report

Investigation Summary

This PR is the result of a /q investigate permissions command investigation into workflow permissions across the gh-aw repository, analyzing live workflow run data from the past 7 days.

Issues Found (from live data)

Missing Explicit Permissions

Problem: 7 workflows lacked explicit permissions: declarations, relying on GitHub Actions default permissions.

Evidence from Live Runs:

  • Run githubnext/gh-aw#18840321667 (Smoke Copilot): 9 warnings - "Permission denied and could not request permission from user"
  • Pattern: copilot-permission-denied
  • Root Cause: Missing explicit permission declarations led to reliance on defaults
  • Data Sources: Analyzed 15 workflow runs over 7 days (2M+ tokens, $1.64 cost)

Workflows Without Explicit Permissions

  1. smoke-copilot.md
  2. smoke-claude.md
  3. smoke-codex.md
  4. smoke-opencode.md
  5. smoke-copilot.firewall.md
  6. daily-news.md
  7. notion-issue-summary.md

Changes Made

Added Explicit Permissions

All 7 workflows now have explicit permissions: declarations following the principle of least privilege:

Smoke Workflows (5 files)

Pattern: Read-only main job + safe-outputs for write operations

permissions:
  contents: read    # For reading repository code
  actions: read     # For workflow metadata

Files modified:

  • smoke-copilot.md
  • smoke-claude.md
  • smoke-codex.md
  • smoke-opencode.md
  • smoke-copilot.firewall.md

Key Point: These workflows use safe-outputs.create-issue with strict: true, so write permissions are handled by separate safe-outputs jobs.

Daily News Workflow

permissions:
  contents: read      # For reading repository code
  discussions: write  # Required for safe-outputs create-discussion job
  actions: read       # For workflow metadata

Note: Uses safe-outputs.create-discussion but NOT in strict mode, so requires explicit write permission.

Notion Issue Summary Workflow

permissions:
  contents: read    # For reading repository code
  issues: read      # For reading issue content
  actions: read     # For workflow metadata

Note: Read-only workflow, no safe-outputs used.

Validation

All modified workflows compiled successfully using gh-aw compile:

  • ✅ smoke-copilot.md (202.8 KB)
  • ✅ smoke-claude.md (177.7 KB)
  • ✅ smoke-codex.md (160.1 KB)
  • ✅ smoke-opencode.md (136.9 KB)
  • ✅ smoke-copilot.firewall.md (202.9 KB)
  • ✅ daily-news.md (210.3 KB)
  • ✅ notion-issue-summary.md (163.1 KB)

Expected Improvements

Security

  • Explicit permission model: No longer relies on implicit GitHub Actions defaults
  • Reduced attack surface: Main AI jobs run with minimal read-only permissions
  • Compliance: Follows principle of least privilege

Reliability

  • Protection from default changes: Workflows won't break if GitHub changes default permissions
  • Clear documentation: Each workflow explicitly declares what it can access
  • Safe-outputs pattern: Write operations isolated in separate jobs

Maintainability

  • Self-documenting: Permissions field shows exactly what each workflow can do
  • Easier auditing: Clear view of permission requirements
  • Consistent pattern: All workflows follow same permission model

Key Learnings

  1. Strict Mode Behavior: Workflows with strict: true cannot have write permissions in main job
  2. Safe-Outputs Architecture: Issue/discussion creation happens in separate jobs with appropriate permissions
  3. Explicit > Implicit: All workflows should declare permissions explicitly
  4. Read-Only Default: Main AI jobs should have minimal read permissions

Investigation Details

Data Sources (all from live workflow runs - no fabricated data):

  • Workflow Runs Analyzed: 15 runs
  • Time Period: Last 7 days (2025-10-20 to 2025-10-27)
  • Total Duration: 40.4 minutes
  • Total Tokens: 2,053,997
  • Total Cost: $1.64
  • Run IDs: 18840301682, 18840299097, 18821713918, 18821735224, and 11 others
  • Logs Location: /tmp/gh-aw/aw-mcp/logs/

References

Note: This PR modifies only .md workflow files. Lock files (.lock.yml) will be regenerated automatically after merge.

AI generated by Q

[!NOTE]
This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download patch artifact

The patch file is available as an artifact (aw.patch) in the work...

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits October 27, 2025 12:25
@pelikhan
Initial exploration - understanding the issue
b99e01f 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan
Add explicit permissions to 7 workflows
9626bbc 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add explicit permissions to seven workflows Add explicit permissions to 7 workflows Oct 27, 2025
Copilot AI requested a review from pelikhan October 27, 2025 12:36
pelikhan
pelikhan reviewed Oct 27, 2025
View reviewed changes
.github/workflows/daily-news.md Outdated
- cron: "0 9 * * 1-5"
workflow_dispatch:

permissions:
Copy link
Contributor

@pelikhan pelikhan Oct 27, 2025

Choose a reason for hiding this comment

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

@copilot needs read-all

Copy link
Contributor Author

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

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

Changed to permissions: read-all in b9fcf87

.github/workflows/smoke-claude.md
- cron: "0 0,6,12,18 * * *" # Every 6 hours
workflow_dispatch:
permissions:
contents: read
Copy link
Contributor

@pelikhan pelikhan Oct 27, 2025

Choose a reason for hiding this comment

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

@copilot needs pull request read

Copy link
Contributor Author

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

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

Added pull-requests: read in b9fcf87

.github/workflows/smoke-codex.md
- cron: "0 0,6,12,18 * * *" # Every 6 hours
workflow_dispatch:
permissions:
contents: read
Copy link
Contributor

@pelikhan pelikhan Oct 27, 2025

Choose a reason for hiding this comment

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

@copilot needs pull request read

Copy link
Contributor Author

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

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

Added pull-requests: read in b9fcf87

.github/workflows/smoke-copilot.firewall.md
- cron: "0 0,6,12,18 * * *" # Every 6 hours
workflow_dispatch:
permissions:
contents: read
Copy link
Contributor

@pelikhan pelikhan Oct 27, 2025

Choose a reason for hiding this comment

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

@copilot needs pull request read

Copy link
Contributor Author

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

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

Added pull-requests: read in b9fcf87

.github/workflows/smoke-copilot.md
- cron: "0 0,6,12,18 * * *" # Every 6 hours
workflow_dispatch:
permissions:
contents: read
Copy link
Contributor

@pelikhan pelikhan Oct 27, 2025

Choose a reason for hiding this comment

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

@copilot needs pull request read

Copy link
Contributor Author

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

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

Added pull-requests: read in b9fcf87

.github/workflows/smoke-opencode.md
schedule:
- cron: "0 0,6,12,18 * * *" # Every 6 hours
workflow_dispatch:
permissions:
Copy link
Contributor

@pelikhan pelikhan Oct 27, 2025

Choose a reason for hiding this comment

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

@copilot needs pull request read

Copy link
Contributor Author

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

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

Added pull-requests: read in b9fcf87

@pelikhan
Add pull-requests: read to smoke workflows and read-all to daily-news
b9fcf87 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review October 27, 2025 12:52
Copilot AI review requested due to automatic review settings October 27, 2025 12:52
@pelikhan pelikhan merged commit a6cd1d6 into main Oct 27, 2025
5 checks passed
@pelikhan pelikhan deleted the copilot/add-explicit-permissions-to-workflows branch October 27, 2025 12:52
Copilot AI reviewed Oct 27, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

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 adds explicit permissions: declarations to 7 agentic workflows that were previously relying on GitHub Actions' default permissions, improving security through the principle of least privilege and preventing potential issues from future GitHub Actions default permission changes.

Key Changes

  • Added explicit read-only permissions (contents: read, actions: read, pull-requests: read) to 5 smoke test workflows
  • Added permissions: read-all to the daily-news workflow based on review feedback
  • Added explicit read permissions to the notion-issue-summary workflow
  • Minor documentation cleanup in the instructions file

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
smoke-opencode.md Added explicit read-only permissions for contents, actions, and pull-requests
smoke-copilot.md Added explicit read-only permissions for contents, actions, and pull-requests
smoke-copilot.firewall.md Added explicit read-only permissions for contents, actions, and pull-requests
smoke-codex.md Added explicit read-only permissions for contents, actions, and pull-requests
smoke-claude.md Added explicit read-only permissions for contents, actions, and pull-requests
notion-issue-summary.md Added explicit read-only permissions for contents, issues, and actions
daily-news.md Added permissions: read-all as requested in review feedback
github-agentic-workflows.instructions.md Simplified documentation examples by removing redundant content
*.lock.yml files Automatically regenerated files reflecting the permission changes from corresponding .md files

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2025

Agentic Changeset Generator triggered by this pull request.

Copilot AI requested a review from pelikhan October 27, 2025 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@pelikhan pelikhan Awaiting requested review from pelikhan

Assignees

@pelikhan pelikhan

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[q] Add explicit permissions to 7 workflows

3 participants

@pelikhan