Tirsvad
a2bf2d4204
Add the use case diagram UCD-001, the user stories US-001 and the brief use cases UC-001 to UC-004 (Synchronize Repository Metadata, Configure Workflow Credentials, Onboard a Repository, Diagnose a Failed Workflow). Review and accept them (RC-019 to RC-024) and the PP-001 row that records them (RC-025), and update TM-001 and the registry. Task: MIL-002#1
1.4 KiB
UC-004: Diagnose a Failed Workflow
Metadata
| Key | Value |
|---|---|
| ID | UC-004 |
| CrossReference | UCD-001, US-001, SA-001 |
Version History
| Date | Status | Author | Reviewer | Change | Commit |
|---|---|---|---|---|---|
| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | pending |
Format: Brief
Title: Diagnose a Failed Workflow Scope: Reusable Workflow Collection Level: user-goal Primary Actor: DevOps Professional Stakeholders: S05, S03 (interests below) Stories: US-001.07, US-001.08
Brief
The DevOps Professional or the Platform Operator opens the failed run, reads the last lines of the failing step and takes the category from the message. The troubleshooting guide maps that category and message to a cause and a fix, which is applied, and the workflow is run again.
Stakeholder interests
- S05 — the cause of a failure is found quickly and fixed once
- S03 — a runner or secret problem is recognised as such and not blamed on the workflow
Preconditions: A run failed or did not start, and the actor can read the run log.
Postconditions (success guarantee): The cause is placed in one category (configuration, credentials, permissions, API response or runner) and the fix from the guide is applied or a defect is raised.