Skip to content

Commit fee614a

Browse files
committed
docs: Level A README — hero line, Mermaid flow diagram, badges, cross-links
Reframes autopilot-demo for portfolio visibility: - Hero line explaining demo target role in the AI repair pipeline - Mermaid flowchart showing demo-to-fix pipeline - CI, Demo CI, and License badges - Cross-links to autopilot-core and org Satisfies ACOR-02
1 parent c134930 commit fee614a

1 file changed

Lines changed: 53 additions & 2 deletions

File tree

README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
1-
# Autopilot Demo Repo
1+
# autopilot-demo
22

3-
Trigger the `Demo CI` workflow to produce a failure. The intake workflow will open an issue with `autofix` and `queued` labels.
3+
[![CI](https://github.com/Coding-Autopilot-System/autopilot-demo/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Coding-Autopilot-System/autopilot-demo/actions/workflows/ci.yml)
4+
[![Demo CI](https://github.com/Coding-Autopilot-System/autopilot-demo/actions/workflows/demo-ci.yml/badge.svg?branch=main)](https://github.com/Coding-Autopilot-System/autopilot-demo/actions/workflows/demo-ci.yml)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
6+
7+
**Demo target for the Coding-Autopilot-System AI repair pipeline** — triggers intake workflows when CI fails, demonstrating end-to-end agentic fix from failure detection to pull request.
8+
9+
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) autonomous CI repair platform. The control plane lives in [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core).
10+
11+
## How the demo works
12+
13+
```mermaid
14+
flowchart LR
15+
A[Trigger Demo CI\nworkflow_dispatch] --> B[demo-ci.yml runs\nubuntu-latest]
16+
B --> C{CI result}
17+
C -->|failure| D[autopilot-create-issue.yml\ncreates intake issue]
18+
D --> E[Issue: autofix + queued]
19+
E --> F[autopilot-core operator\npicks up issue]
20+
F --> G[Codex generates fix]
21+
G --> H[Pull Request opened]
22+
```
23+
24+
1. Trigger `Demo CI` via `workflow_dispatch` to simulate a CI failure.
25+
2. `autopilot-create-issue.yml` detects the failure and creates an issue labeled `autofix + queued`.
26+
3. The [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core) operator scans for the issue and invokes Codex.
27+
4. Codex generates a targeted fix and opens a pull request in this repo.
28+
29+
## Running the demo
30+
31+
```bash
32+
# Trigger the Demo CI workflow (simulates a failure)
33+
gh workflow run demo-ci.yml -R Coding-Autopilot-System/autopilot-demo
34+
35+
# Watch for the intake issue to be created
36+
gh issue list -R Coding-Autopilot-System/autopilot-demo --label autofix --label queued
37+
38+
# Monitor autopilot-core for the fix PR
39+
gh pr list -R Coding-Autopilot-System/autopilot-demo
40+
```
41+
42+
## Workflows
43+
44+
| Workflow | Purpose |
45+
|----------|---------|
46+
| `ci.yml` | Portfolio CI — YAML validation (always passes) |
47+
| `demo-ci.yml` | Demo trigger — simulates CI activity to test intake flow |
48+
| `autopilot-create-issue.yml` | Intake — creates autofix+queued issue on workflow failure |
49+
50+
## Documentation
51+
52+
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-demo/wiki) — setup guide, architecture, configuration reference
53+
- [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core) — operator control plane
54+
- [Coding-Autopilot-System org](https://github.com/Coding-Autopilot-System)

0 commit comments

Comments
 (0)