Skip to content

docs: fix stale status-comment description to reflect auto-enable behavior#24915

Merged
pelikhan merged 2 commits intomainfrom
copilot/update-status-comment-description
Apr 6, 2026
Merged

docs: fix stale status-comment description to reflect auto-enable behavior#24915
pelikhan merged 2 commits intomainfrom
copilot/update-status-comment-description

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 6, 2026

The status-comment field description in both the JSON schema and frontmatter reference incorrectly stated that the field must always be explicitly set to true. In reality, compiler_safe_outputs.go auto-enables it for slash_command and label_command triggers.

Changes

  • pkg/parser/schemas/main_workflow_schema.json — Replaces "Must be explicitly set to true... no automatic bundling with ai-reaction" with accurate language noting auto-enablement for command-based triggers
  • docs/src/content/docs/reference/frontmatter.md — Updates the status-comment: bullet to clarify it is automatically enabled for slash_command/label_command, and only requires explicit opt-in for other trigger types

Copilot AI changed the title [WIP] Update stale status-comment description in schema and documentation docs: fix stale status-comment description to reflect auto-enable behavior Apr 6, 2026
Copilot AI requested a review from pelikhan April 6, 2026 15:33
@pelikhan pelikhan marked this pull request as ready for review April 6, 2026 16:04
Copilot AI review requested due to automatic review settings April 6, 2026 16:04
@pelikhan pelikhan merged commit e67d41b into main Apr 6, 2026
3 checks passed
@pelikhan pelikhan deleted the copilot/update-status-comment-description branch April 6, 2026 16:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation for the on.status-comment frontmatter field to reflect that it is auto-enabled for command-based triggers, rather than always requiring an explicit true.

Changes:

  • Updated status-comment description in the main workflow JSON schema to mention auto-enablement for slash_command/label_command.
  • Updated the frontmatter reference to clarify when status-comment: true is required vs. defaulted.
Show a summary per file
File Description
pkg/parser/schemas/main_workflow_schema.json Adjusts schema field description for on.status-comment to match defaulting behavior.
docs/src/content/docs/reference/frontmatter.md Updates frontmatter reference bullet for status-comment: to document auto-enable behavior.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (1)

docs/src/content/docs/reference/frontmatter.md:34

  • There is still a stale statement in docs/src/content/docs/reference/triggers.md (around the Status Comments section) that says status comments "must be explicitly enabled" with no mention of the auto-enable behavior for command-based triggers. Consider updating that doc as well to keep the reference pages consistent.
- `status-comment:` - Post a started/completed comment with a workflow run link (automatically enabled for `slash_command` and `label_command` triggers; must be explicitly set to `true` for other trigger types)
- `stop-after:` - Automatically disable triggers after a deadline
  • Files reviewed: 2/2 changed files
  • Comments generated: 2

"status-comment": {
"type": "boolean",
"description": "Whether to post status comments (started/completed) on the triggering item. When true, adds a comment with workflow run link and updates it on completion. When false or not specified, no status comments are posted. Must be explicitly set to true to enable status comments - there is no automatic bundling with ai-reaction.",
"description": "Whether to post status comments (started/completed) on the triggering item. When true, adds a comment with workflow run link and updates it on completion. When false or not specified, no status comments are posted. Automatically enabled for slash_command and label_command triggers — manual configuration is only needed for other trigger types.",
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description is internally inconsistent: it says "When false or not specified, no status comments are posted", but then states status comments are automatically enabled for command-based triggers. Consider rephrasing to reflect the actual defaulting behavior (e.g., defaults to true for slash_command/label_command (and deprecated command) triggers, otherwise defaults to false; false always disables).

Suggested change
"description": "Whether to post status comments (started/completed) on the triggering item. When true, adds a comment with workflow run link and updates it on completion. When false or not specified, no status comments are posted. Automatically enabled for slash_command and label_command triggers — manual configuration is only needed for other trigger types.",
"description": "Whether to post status comments (started/completed) on the triggering item. When true, adds a comment with workflow run link and updates it on completion. When false, status comments are disabled. When not specified, defaults to true for slash_command, label_command, and deprecated command triggers; otherwise defaults to false.",

Copilot uses AI. Check for mistakes.
- Standard GitHub Actions triggers (push, pull_request, issues, schedule, etc.)
- `reaction:` - Add emoji reactions to triggering items
- `status-comment:` - Post a started/completed comment with a workflow run link (must be explicitly set to `true`; not automatically enabled by `reaction:`)
- `status-comment:` - Post a started/completed comment with a workflow run link (automatically enabled for `slash_command` and `label_command` triggers; must be explicitly set to `true` for other trigger types)
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bullet says status comments are auto-enabled for slash_command/label_command, but the compiler also auto-enables them for the deprecated command trigger. Either mention command here (even as deprecated) or clarify that the behavior applies to all command-based triggers so docs match runtime behavior.

This issue also appears on line 33 of the same file.

Suggested change
- `status-comment:` - Post a started/completed comment with a workflow run link (automatically enabled for `slash_command` and `label_command` triggers; must be explicitly set to `true` for other trigger types)
- `status-comment:` - Post a started/completed comment with a workflow run link (automatically enabled for command-based triggers such as `slash_command`, `label_command`, and deprecated `command`; must be explicitly set to `true` for other trigger types)

Copilot uses AI. Check for mistakes.
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.

[deep-report] Update stale status-comment description in schema and documentation

3 participants