Design: automatic CI-failure issue filing (workflow_run monitor)#79
Merged
Conversation
…tor) Design doc for Option 2: a repo-wide report-ci-failure.yml workflow that subscribes to monitored workflows via workflow_run and opens/updates a deduped 'CI failure: <workflow>' issue (new manage-failure-issue action). Documents the startup_failure caveat, phased delivery, and alternatives. Proposed/under review; no code yet.
5 tasks
There was a problem hiding this comment.
Pull request overview
Adds a proposed architecture/design document describing a repository-wide GitHub Actions workflow_run monitor that files a de-duplicated GitHub issue when selected CI workflows conclude with failure.
Changes:
- Introduces the overall approach (single
workflow_runmonitor workflow) and how it would identify failures. - Specifies proposed components (
report-ci-failure.yml+ newmanage-failure-issuecomposite action) and issue de-duplication/lifecycle rules. - Documents limitations (
startup_failure) and outlines phased delivery + security considerations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ming phrasing, tracking links)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the design document for Option 2 — a repository-wide
workflow_runmonitor that automatically files (and de-duplicates) a GitHub issue when a monitored workflow concludes in failure.New doc: docs/architecture/workflows/ci-failure-notifications.md.
Highlights
report-ci-failure.yml(report / ci-failure) subscribes to monitored workflows viaworkflow_runand, onconclusion == failure, opens/updates a dedupedCI failure: <workflow>issue.manage-failure-issue(kept separate from the promotion-specificmanage-issueto avoid destabilising the override flow).startup_failurecaveat:workflow_runis not reliably emitted for startup failures; prevention (actionlint/CodeQL/review) remains the mitigation for that class.ci-failuretemplate.Process
Design only — no code yet. Implementation is tracked by a tracking issue + child tasks filed alongside this PR. Per the repo's process, this doc is up for review before implementation begins.