Skip to content

Comments

Add safe outputs option taxonomy matrix and DOC-001 conformance check#17397

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/add-safe-outputs-documentation
Closed

Add safe outputs option taxonomy matrix and DOC-001 conformance check#17397
Copilot wants to merge 2 commits intomainfrom
copilot/add-safe-outputs-documentation

Conversation

Copy link
Contributor

Copilot AI commented Feb 21, 2026

Safe output options (target, target-repo, allowed-repos, filters, max, fallback) are conceptually similar across types but had no single reference for comparison, making capability discovery difficult and leaving room for docs/code drift.

Changes

docs/src/content/docs/reference/safe-outputs.md

  • Adds submit-pull-request-review to the Available Safe Output Types index — it had a full docs section but was absent from the listing
  • Adds a new ## Option Taxonomy section: a single table covering all 36 safe output types with columns for target, target-repo, allowed-repos, type-specific filters, max default, and fallback/expiry behavior
  • Includes column-level notes clarifying semantics and a callout for same-repo-only types and create-project's target-owner pattern

scripts/check-safe-outputs-conformance.sh

  • Adds DOC-001 check: extracts type names from both the "Available Safe Output Types" list and the "Option Taxonomy" matrix first-column entries, then diffs them
    • MEDIUM severity if any listed type is absent from the matrix (drift from index → matrix)
    • LOW severity for any matrix entry not in the index (phantom entries)

scripts/README-conformance.md

  • Adds a Documentation Checks section documenting DOC-001

Matrix excerpt

Safe Output Type target target-repo allowed-repos Filters max (default) Fallback / Expires
create-issue allowed-labels 1 expires, close-older-issues
close-issue required-labels, required-title-prefix 1
add-labels allowed, blocked 3
dispatch-workflow 3 (fixed)
Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Add safe outputs option taxonomy and conformance matrix to docs</issue_title>
<issue_description>## Context

From the safe outputs audit in #17317, safe output options (targeting, repo scope, filters, limits, fallback) are conceptually similar but not uniformly documented across outputs, making it difficult for users to compare capabilities at a glance.

Problem

There is no single reference that shows which options are supported by which safe output type, leading to user confusion and potential drift between docs, types, and implementation.

Approach

  1. Add a matrix/table section to docs/src/content/docs/reference/safe-outputs.md with columns:
    • Targeting (target)
    • Repo scope (target-repo, allowed-repos)
    • Filters (required-*, allowed-*, blocked)
    • Limits (max, fixed max)
    • Fallback behavior
  2. Add a CI conformance check (script or test) to ensure docs and code surfaces stay aligned (key naming, options available)

Files to Modify

  • docs/src/content/docs/reference/safe-outputs.md
  • scripts/check-safe-outputs-conformance.sh (create if needed) or equivalent conformance tests

Acceptance Criteria

  • A single comparison table in docs covers all safe output types and their supported options
  • CI check (or test) fails when key naming drifts between docs, types, and implementation
  • No runtime behavior changes — this is documentation and validation only
    Related to Safe outputs audit (consistency, overlap, gaps) #17317

Generated by Plan Command for issue #17317

  • expires on Feb 23, 2026, 4:54 AM UTC

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Add submit-pull-request-review to Available Safe Output Types list
- Add ## Option Taxonomy section to safe-outputs.md with comparison table
  showing all 36 types and their supported options (target, target-repo,
  allowed-repos, filters, max, fallback/expires)
- Add DOC-001 conformance check to scripts/check-safe-outputs-conformance.sh
  that verifies all listed types appear in the matrix
- Document DOC-001 check in scripts/README-conformance.md

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add safe outputs option taxonomy and conformance matrix to docs Add safe outputs option taxonomy matrix and DOC-001 conformance check Feb 21, 2026
@pelikhan pelikhan closed this Feb 21, 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.

[plan] Add safe outputs option taxonomy and conformance matrix to docs

2 participants