Skip to content

docs: Documentation analysis and improvement#1098

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs-issue-1097-permissions-4b974bd89ca47e56
Draft

docs: Documentation analysis and improvement#1098
github-actions[bot] wants to merge 1 commit into
mainfrom
docs-issue-1097-permissions-4b974bd89ca47e56

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Closes #1097

Summary of files analyzed

  • docs/workflows/docs-aw-client-template.md
  • .github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-ai-menu.yml
  • .github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu.yml
  • .github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu-collect.yml

Issues found

  • docs/workflows/docs-aw-client-template.md: Top-level permission guidance listed only contents: read, but all current Docs client templates also declare issues: read.
  • docs/workflows/docs-aw-client-template.md: The permission matrix row for trigger-docs-aw-pr-ai-menu-collect.yml omitted issues: read in the documented run-aw permission union.

Changes made

  • Updated top-level client-template permissions in docs/workflows/docs-aw-client-template.md to include issues: read so docs reflect the current distributed templates.
  • Added a short rationale note explaining issues: read is needed for issue_comment routing and metadata lookups, to reduce future documentation drift.
  • Updated the permission matrix row for trigger-docs-aw-pr-ai-menu-collect.yml to include issues: read, matching the workflow template's effective permissions.

What is this? | From workflow: Observability Agentic Workflow — Autodoc

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Update Docs client-template permission guidance to include top-level issues: read and add issues: read in the collect template run-aw permission matrix row, matching the current distributed templates.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

[oblt-aw][autodoc] Update docs-aw client template permissions docs for new issues:read requirements

0 participants