Skip to content

Commit a9ff4be

Browse files
committed
docs: Level A README — hero line, Mermaid diagram, CI badge, cross-links
Reframes autopilot-core for portfolio visibility: - Hero line describing the AI operator capability - Mermaid flowchart showing end-to-end repair pipeline - CI and License badges - Cross-links to sibling repos and wiki Satisfies ACOR-01
1 parent 7f811ae commit a9ff4be

1 file changed

Lines changed: 44 additions & 40 deletions

File tree

README.md

Lines changed: 44 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,57 @@
1-
# Autopilot Core
1+
# autopilot-core
22

3-
Organization-level control plane and operator for CI Autopilot.
3+
[![CI](https://github.com/Coding-Autopilot-System/autopilot-core/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Coding-Autopilot-System/autopilot-core/actions/workflows/ci.yml)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
45

5-
## Architecture
6+
**Org-level AI autopilot operator** — scans GitHub issues labeled `autofix + queued`, invokes Codex to generate fixes, and opens pull requests automatically across the Coding-Autopilot-System organization.
67

7-
```
8-
[Workflow Failure]
9-
|
10-
v
11-
[autopilot-create-issue.yml]
12-
- create/update issue (labels)
13-
|
14-
v
15-
[autopilot-operator.yml] (self-hosted)
16-
- scans queued issues
17-
- runs Codex
18-
- opens PRs
19-
```
8+
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) autonomous CI repair platform alongside [ci-autopilot](https://github.com/Coding-Autopilot-System/ci-autopilot) and [autopilot-demo](https://github.com/Coding-Autopilot-System/autopilot-demo).
209

2110
## How it works
22-
- Failures trigger issue intake in the originating repo.
23-
- Issues labeled `autofix` + `queued` are eligible for automation.
24-
- The operator runs on a self-hosted runner and attempts safe fixes.
2511

26-
## Quick start
27-
1) Set org variable `ORG` in GitHub Actions for this repo.
28-
2) Install `autopilot-create-issue.yml` into target repos.
29-
3) Ensure a self-hosted runner is online for this repo.
30-
4) Run `autopilot-operator.yml` manually to validate.
12+
```mermaid
13+
flowchart LR
14+
A[CI Failure] --> B[autopilot-create-issue.yml]
15+
B --> C[Issue: autofix + queued]
16+
C --> D[autopilot-operator.yml]
17+
D --> E[Codex Fix Generation]
18+
E --> F[Pull Request Opened]
19+
F --> G[Auto-merge / Review]
20+
```
3121

32-
## Org installer
33-
`autopilot-org-installer.yml` scans the org hourly and opens PRs for repos that opt in via `.autopilot/opt-in`.
22+
1. A CI failure in any opted-in repo triggers `autopilot-create-issue.yml`, creating an issue labeled `autofix + queued`.
23+
2. `autopilot-operator.yml` runs on a schedule on the self-hosted Windows runner, scanning for labeled issues.
24+
3. For each eligible issue, the operator invokes Codex to generate a targeted fix.
25+
4. The fix is committed to a branch and a pull request is opened in the target repo.
26+
5. `autopilot-org-installer.yml` scans the org hourly and installs the intake workflow into repos that opt in via `.autopilot/opt-in`.
3427

35-
## Dashboard
36-
- Live dashboard: https://coding-autopilot-system.github.io/autopilot-core/
37-
- Status snapshot: `docs/status.md`
28+
## Quick start
3829

39-
## Current Autopilot Status
40-
<!-- AUTOPILOT-STATUS:START -->
41-
Last updated: 1970-01-01T00:00:00Z
42-
See `docs/status.md` for the full status table.
43-
<!-- AUTOPILOT-STATUS:END -->
30+
1. Set org variable `ORG` in GitHub Actions for this repo.
31+
2. Install `autopilot-create-issue.yml` into target repos (or use `autopilot-org-installer.yml`).
32+
3. Ensure a self-hosted Windows runner with Codex and `OPENAI_API_KEY` is online.
33+
4. Trigger `autopilot-operator.yml` manually to validate the setup.
4434

4535
## Safety guardrails
46-
- Acts only on `autofix + queued` issues.
47-
- Skips anything labeled `risky` or `needs-design`.
48-
- Minimal diffs, no secrets, no destructive ops.
36+
37+
- Acts only on issues labeled `autofix + queued`.
38+
- Skips issues labeled `risky` or `needs-design`.
39+
- Minimal diffs only — no secrets, no destructive operations.
4940
- Best-effort verification before PR creation.
5041

51-
## Demos
52-
- `docs/demos/demo-repo.md`
53-
- `templates/demo-repo/`
42+
## Workflows
43+
44+
| Workflow | Trigger | Purpose |
45+
|----------|---------|---------|
46+
| `ci.yml` | push/PR to main | Portfolio CI — YAML validation (ubuntu-latest) |
47+
| `autopilot-operator.yml` | schedule + dispatch | Core operator — scan issues, run Codex, open PRs |
48+
| `autopilot-org-installer.yml` | hourly + dispatch | Install intake workflow into opted-in repos |
49+
| `autopilot-create-issue.yml` | workflow_run failure | Create intake issue when monitored workflow fails |
50+
| `autopilot-docs-daily.yml` | daily | Update dashboard status page |
51+
52+
## Documentation
53+
54+
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-core/wiki) — setup guide, architecture, configuration reference
55+
- [Dashboard](https://coding-autopilot-system.github.io/autopilot-core/) — live autopilot status
56+
- `docs/status.md` — status snapshot
57+
- `docs/runbooks/` — operational runbooks

0 commit comments

Comments
 (0)