Skip to content

docs: document create-github-issue and set-github-issue-type safe outputs - #1803

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/github-issue-safe-outputs-6394e274798293eb
Draft

docs: document create-github-issue and set-github-issue-type safe outputs#1803
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/github-issue-safe-outputs-6394e274798293eb

Conversation

@github-actions

@github-actions github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Documented the new create-github-issue and set-github-issue-type safe outputs (added in feat(safeoutputs): add GitHub issue outputs #1670, commit 18c87dc) for human readers — this is a major public safe-output surface that writes to GitHub (not ADO) from Stage 3 only, and it had zero coverage in README.md or the docs site (only docs/safe-outputs.md, which is agent-facing and out of scope here).

Changes

  • README.md:
    • Added both tools to the Safe Outputs table.
    • Added a new "Example: GitHub Issue Configuration" section covering target-repo, allowed-labels, require-temporary-id, allowed issue types, and the ADO_AW_GITHUB_TOKEN secret setup, with a pointer to the site reference for GitHub App auth details.
  • site/src/content/docs/reference/safe-outputs.mdx:
    • Added a full "GitHub issue safe outputs" section: authentication (default secret, custom macro, shared/separate GitHub App), target-repo rules, per-tool config/agent-parameter tables for create-github-issue and set-github-issue-type, and temporary-ID linkage/approval-gating rules between the two tools.

Accuracy checks

  • All field names, defaults, and behavior (e.g. allowed-labels default-deny vs allowed type default-allow, require-approval co-gating, temporary-ID format #aw_ + 3-12 chars, Stage-3-only credential isolation) verified against docs/safe-outputs.md (the existing agent-facing reference for this feature) and cross-checked against src/safe_outputs/create_github_issue.rs / set_github_issue_type.rs.

Validation

  • cd site && npm run build:astro (full npm run build fails only on the pre-existing, unrelated slides Playwright/Chromium download, which is blocked by this sandbox's network policy — not caused by this change). Build succeeded, 38 pages generated, all internal links validated.
  • README re-read for valid Markdown, working links, and consistent table formatting.

Created by the docs-writer workflow.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • cdn.playwright.dev

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "cdn.playwright.dev"

See Network Configuration for more information.

Generated by Docs Writer · aut00 · 66 AIC · ⌖ 12.8 AIC · ⊞ 11.6K ·

…puts

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
2 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@github-actions github-actions Bot mentioned this pull request Aug 4, 2026
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.

0 participants