Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-03-04#19646

Open
github-actions[bot] wants to merge 2 commits intomainfrom
doc-healer/secrecy-integrity-2026-03-04-be1a2af33adfa6a9
Open

[docs] Self-healing documentation fixes from issue analysis - 2026-03-04#19646
github-actions[bot] wants to merge 2 commits intomainfrom
doc-healer/secrecy-integrity-2026-03-04-be1a2af33adfa6a9

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Mar 4, 2026

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

  • Commit Display secrecy and integrity fields in safe output step summary renderer #19552 (Display secrecy and integrity fields in safe output step summary renderer, merged 2026-03-04) exposed these fields in step summaries, but they were never documented in safe-outputs.md where users would look for configuration guidance. The fields are defined in BaseSafeOutputItem in actions/setup/js/types/safe-outputs.d.ts and briefly referenced in the glossary, but lacked any usage documentation.

Change: Added a ### Security Metadata (\secrecy`, `integrity`)subsection to the **Global Configuration Options** section ofdocs/src/content/docs/reference/safe-outputs.md`. The new section:

  • Explains these are agent output fields (not frontmatter options)
  • Documents accepted values for each field
  • Notes they appear in the workflow step summary
  • Provides a concrete JSON example
  • Links to the existing Glossary entries

Root Cause

DDUw scans merged PRs from the last 24 hours only. The secrecy/integrity fields were introduced in the type definitions before DDUw's scan window, and no open documentation-labeled issue existed to trigger DDUw's issue-driven check (step 1b). The feature predated DDUw's coverage window and had no corresponding open issue — so no existing DDUw heuristic would detect it.

DDUw Improvement Suggestions

  1. Extend glossary→docs cross-check: When DDUw scans for doc gaps, it should check whether terms defined in glossary.md are also documented in the primary reference file for their domain. A secrecy/integrity glossary entry pointing at "safe output tool calls" but absent from safe-outputs.md is a detectable inconsistency.

  2. Scan BaseSafeOutputItem and type intersections: DDUw could periodically diff fields in actions/setup/js/types/safe-outputs.d.ts (particularly BaseSafeOutputItem) against the documented fields in safe-outputs.md. Any undocumented field in the base interface is a gap candidate.

  3. Step-summary renderer as a trigger signal: Any commit that adds display of a new field in a step summary renderer (like safe_output_summary.cjs) should automatically be flagged for documentation review — the display implies a user-visible feature.

Related Commits

Generated by Daily Documentation Healer ·

  • expires on Mar 7, 2026, 7:28 PM UTC

…e outputs

Add a new "Security Metadata" subsection to the Global Configuration
Options section of safe-outputs.md documenting the secrecy and integrity
optional fields available on all safe output tool calls.

These fields have been defined in BaseSafeOutputItem (safe-outputs.d.ts)
and referenced in the glossary but were missing from the main reference
documentation. Commit #19552 added display of these fields in the step
summary renderer, making them more visible to users who will look for
configuration guidance.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants