Skip to content

Harden autopilot-core portfolio docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OgeonX-Ai merged 1 commit into from
Jun 10, 2026
Merged

Harden autopilot-core portfolio docs #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@
[![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)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

**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.
**Org-level AI autopilot control plane** - scans GitHub issues labeled `autofix + queued`, invokes Codex to generate fixes, and opens pull requests automatically across the Coding-Autopilot-System organization.

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).

## Repo boundary

- `autopilot-core` is the control plane: org-wide intake governance, operator scheduling, PR creation, and rollout visibility.
- `ci-autopilot` is the worker/runtime pattern: the runner-hosted Python agent and workflow assets used to execute repairs.

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Describe the repair runtime owned by autopilot-core

This boundary description implies that ci-autopilot provides the runtime used to execute repairs, but the repair path defined in this repository runs its own PowerShell operator: .github/workflows/autopilot-operator.yml invokes scripts/autopilot-operator.ps1, which calls Codex, verifies changes, commits, pushes, and opens the PR. Readers using this section to understand ownership will therefore incorrectly attribute a core responsibility to the adjacent repository; describe ci-autopilot as a separate implementation/pattern, or acknowledge that autopilot-core also owns its operator runtime.

Useful? React with 👍 / 👎.

- `autopilot-demo` is the proof repo: a safe target that demonstrates the full failure-to-fix loop.

## How it works

```mermaid
Expand All @@ -28,30 +34,39 @@ flowchart LR
## Quick start

1. Set org variable `ORG` in GitHub Actions for this repo.
2. Install `autopilot-create-issue.yml` into target repos (or use `autopilot-org-installer.yml`).
2. Install `autopilot-create-issue.yml` into target repos, or use `autopilot-org-installer.yml`.
3. Ensure a self-hosted Windows runner with Codex and `OPENAI_API_KEY` is online.
4. Trigger `autopilot-operator.yml` manually to validate the setup.

## Enterprise proof points

- Centralized control plane with explicit issue-queue handoff instead of opaque direct mutation.
- Auditable lifecycle: CI failure, intake issue, operator run, fix branch, and PR are all visible in GitHub.
- Guardrailed execution: label-gated intake, skip labels for risky work, and verification before PR creation.
- Org-scale rollout path: installer workflow distributes intake automation to opted-in repositories.

## Safety guardrails

- Acts only on issues labeled `autofix + queued`.
- Skips issues labeled `risky` or `needs-design`.
- Minimal diffs only — no secrets, no destructive operations.
- Minimal diffs only - no secrets, no destructive operations.
- Best-effort verification before PR creation.

## Workflows

| Workflow | Trigger | Purpose |
|----------|---------|---------|
| `ci.yml` | push/PR to main | Portfolio CI — YAML validation (ubuntu-latest) |
| `autopilot-operator.yml` | schedule + dispatch | Core operator — scan issues, run Codex, open PRs |
| `ci.yml` | push/PR to main | Portfolio CI - YAML validation (ubuntu-latest) |
| `autopilot-operator.yml` | schedule + dispatch | Core operator - scan issues, run Codex, open PRs |
| `autopilot-org-installer.yml` | hourly + dispatch | Install intake workflow into opted-in repos |
| `autopilot-create-issue.yml` | workflow_run failure | Create intake issue when monitored workflow fails |
| `autopilot-docs-daily.yml` | daily | Update dashboard status page |

## Documentation

- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-core/wiki) — setup guide, architecture, configuration reference
- [Dashboard](https://coding-autopilot-system.github.io/autopilot-core/) — live autopilot status
- `docs/status.md` — status snapshot
- `docs/runbooks/` — operational runbooks
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-core/wiki) - setup guide, architecture, configuration reference
- [Dashboard](https://coding-autopilot-system.github.io/autopilot-core/) - live autopilot status
- [docs/status.md](docs/status.md) - status snapshot
- [docs/runbooks/operator.md](docs/runbooks/operator.md) - operator runbook
- [docs/runbooks/install-to-repo.md](docs/runbooks/install-to-repo.md) - repo onboarding runbook
- [docs/demos/demo-repo.md](docs/demos/demo-repo.md) - demo walkthrough using `autopilot-demo`
8 changes: 8 additions & 0 deletions memory/examples/20260610_autopilot-core_boundary-readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# 20260610_autopilot-core_boundary-readme

Issue Description: README did not clearly distinguish control plane responsibilities from worker/runtime and demo repos.
State: Portfolio readers could not quickly tell what `autopilot-core` owns.
Action: Added a repo boundary section, enterprise proof points, and direct runbook/demo links in `README.md`.
Result: The repo now presents itself as the org-level control plane with clearer adjacent-repo boundaries.
Diff Patch: Updated `README.md` only.
Rationale: Hiring and architecture readers need the control-plane role to be obvious within the first screen.
Loading