Skip to content

[docs] Self-healing documentation fix: workflow_run.conclusion filter - 2026-04-30#29324

Merged
pelikhan merged 2 commits intomainfrom
docs/healer-workflow-run-conclusion-2026-04-30-043d180a406f24c6
Apr 30, 2026
Merged

[docs] Self-healing documentation fix: workflow_run.conclusion filter - 2026-04-30#29324
pelikhan merged 2 commits intomainfrom
docs/healer-workflow-run-conclusion-2026-04-30-043d180a406f24c6

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Self-Healing Documentation Fixes

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

Gaps Fixed

Root Cause

DDUw ran on 2026-04-29 at 11:18 UTC (PR #29083). Commit #29089 landed at 13:21 UTC — after that run. Today's DDUw run (PR #29288) documented --stdin from #29170 but missed the workflow_run.conclusion feature from #29089, which was also in its 24-hour window. The feature name ("compile filter into if condition") did not match the pattern DDUw typically scans for ("new flag" or "new frontmatter field"), and the ADR-style commit message obscured its user-facing nature.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

Problem: DDUw skipped on.workflow_run.conclusion even though it fell within the 24-hour window.

Root cause: The commit message was feat: add on.workflow_run.conclusion filter support — a clear user-facing feature — but today's DDUw PR (#29288) documented only --stdin with no mention of workflow_run.conclusion. DDUw likely evaluated the commit's changed files (pkg/workflow/frontmatter_extraction_yaml.go, .github/aw/create-agentic-workflow.md, an ADR file) and concluded the feature was internal or already covered by the ADR.

Suggested Step 2 heuristic addition in .github/workflows/daily-doc-updater.md:

When a feat: commit modifies pkg/workflow/frontmatter_extraction_yaml.go or a file matching pkg/workflow/compiler_*, grep that file's diff for new field names being extracted (e.g., getStringField, getStringSliceField, newly exported YAML keys). Each such field is a user-facing frontmatter addition that MUST be documented in docs/src/content/docs/reference/triggers.md or docs/src/content/docs/reference/frontmatter.md. Do not treat an ADR commit as documentation coverage for the feature itself.

Related Issues

References:

Generated by Daily Documentation Healer · ● 531.5K ·

  • expires on May 3, 2026, 1:38 PM UTC

Add Conclusion Filtering subsection to the Workflow Run Triggers
section, mirroring the existing deployment_status.state documentation.

The on.workflow_run.conclusion field (added in #29089) compiles into a
guarded if: condition at build time, allowing users to filter workflow
runs by their conclusion without writing the two-part GitHub Actions
expression guard manually.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 30, 2026
@pelikhan pelikhan marked this pull request as ready for review April 30, 2026 13:45
Copilot AI review requested due to automatic review settings April 30, 2026 13:45
@pelikhan
Copy link
Copy Markdown
Collaborator

@copilot unbloat changes

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

Adds missing reference documentation for the newly supported on.workflow_run.conclusion frontmatter filter.

Changes:

  • Documented workflow_run.conclusion syntax for single and multiple values.
  • Listed valid conclusion values and explained how the compiler implements the filter via a guarded if: condition.
Show a summary per file
File Description
docs/src/content/docs/reference/triggers.md Adds a workflow_run subsection documenting the new conclusion: filter and its compiled behavior.

Copilot's findings

Tip

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

  • Files reviewed: 1/1 changed files
  • Comments generated: 1


#### Conclusion Filtering (`conclusion:`)

Use `conclusion:` to restrict the trigger to specific workflow run outcomes. The compiler compiles this into a guarded `if:` condition so the workflow only runs for the matching conclusions. Other combined triggers (such as `workflow_dispatch`) are not blocked by the guard.
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

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

The wording here implies conclusion: filters the trigger ("restrict the trigger" / "workflow only runs"), but GitHub Actions can’t filter workflow_run at the event level; this feature is implemented by compiling conclusion: into an if: on the activation job. As a result, a run may still be created and then skipped when the conclusion doesn’t match. Consider rephrasing to explicitly say the compiler injects a guarded activation-job if: that skips execution unless the conclusion matches (while remaining a no-op for other events).

Suggested change
Use `conclusion:` to restrict the trigger to specific workflow run outcomes. The compiler compiles this into a guarded `if:` condition so the workflow only runs for the matching conclusions. Other combined triggers (such as `workflow_dispatch`) are not blocked by the guard.
For `workflow_run`, use `conclusion:` to have the compiler inject a guarded `if:` on the activation job for specific workflow run outcomes. This does not filter the GitHub Actions event itself: a workflow run may still be created and then skipped when the conclusion does not match. Other combined triggers (such as `workflow_dispatch`) are not blocked by the guard.

Copilot uses AI. Check for mistakes.
@github-actions github-actions Bot mentioned this pull request Apr 30, 2026
Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 30, 2026

@copilot unbloat changes

Trimmed in 793e2b7 — removed the duplicate code example and verbose NOTE block, cutting from 26 added lines down to 14.

Copilot AI requested a review from pelikhan April 30, 2026 13:52
@pelikhan pelikhan merged commit 2ce4561 into main Apr 30, 2026
@pelikhan pelikhan deleted the docs/healer-workflow-run-conclusion-2026-04-30-043d180a406f24c6 branch April 30, 2026 14:00
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.

3 participants