Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-04-02 #24116

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 1 commit into from
Apr 2, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-04-02 #24116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions 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,6 +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:`)
- `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
22 changes: 19 additions & 3 deletions docs/src/content/docs/reference/triggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,13 +346,29 @@ on:
reaction: "eyes"
```

The reaction is added to the triggering item. For issues/PRs, a comment with the workflow run link is created. For comment events in command workflows, the comment is edited to include the run link.
The reaction is added to the triggering item. Use `none` to disable reactions entirely.

**Available reactions:** `+1` 👍, `-1` 👎, `laugh` 😄, `confused` 😕, `heart` ❤️, `hooray` 🎉, `rocket` 🚀, `eyes` 👀

### Status Comments (`status-comment:`)

Post a started/completed comment on the triggering item with a link to the workflow run:

```yaml wrap
on:
issues:
types: [opened]
reaction: "eyes"
status-comment: true
```

When `status-comment: true`, the activation job posts a comment when the workflow starts and updates it when the run completes. This must be **explicitly enabled** — setting `reaction:` alone does not create status comments.
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

The sentence attributes both creating and updating the status comment to the activation job. In the generated workflow, the activation job can post the initial status comment, but the completion update happens later (e.g., via the conclusion/notify job). Consider rewording to describe this as a workflow-level behavior (posts at start, updates on completion) without implying the activation job performs the update step itself.

Suggested change
When `status-comment: true`, the activation job posts a comment when the workflow starts and updates it when the run completes. This must be **explicitly enabled** — setting `reaction:` alone does not create status comments.
When `status-comment: true`, the workflow posts a comment when it starts and updates that comment when the run completes (for example, the activation job may create the comment and a later job updates it). This must be **explicitly enabled** — setting `reaction:` alone does not create status comments.

Copilot uses AI. Check for mistakes.

To suppress status comments, omit `status-comment:` or set it to `false`.

### Activation Token (`on.github-token:`, `on.github-app:`)

Configure a custom GitHub token or GitHub App for the activation job **and all skip-if search checks**. The activation job posts the initial reaction and status comment on the triggering item, and skip-if checks use the same token to query the GitHub Search API. By default all of these operations use the workflow's `GITHUB_TOKEN`.
Configure a custom GitHub token or GitHub App for the activation job **and all skip-if search checks**. The activation job posts the initial reaction (and status comment if `status-comment: true`) on the triggering item, and skip-if checks use the same token to query the GitHub Search API. By default all of these operations use the workflow's `GITHUB_TOKEN`.

Use `github-token:` to supply a PAT or custom token:

Expand All @@ -376,7 +392,7 @@ on:
private-key: ${{ secrets.APP_KEY }}
```

The `github-app` object accepts the same fields as the GitHub App configuration used elsewhere in the framework (`app-id`, `private-key`, and optionally `owner` and `repositories`). The token is minted once in the pre-activation job and is shared across the reaction step, the status comment step, and any skip-if search steps.
The `github-app` object accepts the same fields as the GitHub App configuration used elsewhere in the framework (`app-id`, `private-key`, and optionally `owner` and `repositories`). The token is minted once in the pre-activation job and is shared across the reaction step, the status comment step (if `status-comment: true`), and any skip-if search steps.

Both `github-token` and `github-app` can be defined in a **shared agentic workflow** and will be automatically inherited by any workflow that imports it (first-wins strategy). This means a central CentralRepoOps shared workflow can define the app config once and all importing workflows benefit automatically:

Expand Down
Loading