Skip to content

[Code Quality] Fix glossary doc: status-comment belongs under on:, not safe-outputs #50966

Description

@github-actions

Description

A schema consistency audit (discussion #50792) found that docs/src/content/docs/reference/glossary.md incorrectly states that status-comment: true is configured in safe-outputs. The implementation and other docs place it under on: instead.

Suggested Changes

  • Update docs/src/content/docs/reference/glossary.md so the status-comment entry describes it as configured under on: (matching docs/src/content/docs/reference/frontmatter.md and docs/src/content/docs/reference/triggers.md)
  • Verify against pkg/workflow/trigger_parser.go, which parses status-comment from the on map, to confirm the corrected wording matches implementation

Files Affected

  • docs/src/content/docs/reference/glossary.md

Success Criteria

  • Glossary entry for status-comment correctly describes it as an on: field
  • Wording is consistent with frontmatter.md and triggers.md

Source

Extracted from Schema Consistency Check - 2026-08-06 (discussion #50792)

Priority

Low - documentation-only fix, quick and low risk

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · auto · 35.3 AIC · ⌖ 4.12 AIC · ⊞ 10.2K ·

  • expires on Aug 7, 2026, 5:44 PM UTC-08:00

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions