Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Apr 6, 2026
+2 −2
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5301ee1
Initial plan
Copilot Apr 6, 2026
b8ec9c6
docs: update stale status-comment description in schema and documenta…
Copilot Apr 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/content/docs/reference/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The `on:` section uses standard GitHub Actions syntax to define workflow trigger

- 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.
- `stop-after:` - Automatically disable triggers after a deadline
- `manual-approval:` - Require manual approval using environment protection rules
- `forks:` - Configure fork filtering for pull_request triggers
Expand Down
2 changes: 1 addition & 1 deletion pkg/parser/schemas/main_workflow_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@
},
"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.
"examples": [true, false]
},
"github-token": {
Expand Down
Loading