Skip to content

Harden ci-autopilot portfolio docs #1965

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 11, 2026
Merged

Harden ci-autopilot portfolio docs #1965

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
38 changes: 29 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# ci-autopilot

AI-powered CI autopilot — detects GitHub Actions failures and autonomously dispatches repairs via a Python agent
AI-powered CI autopilot worker/runtime - detects GitHub Actions failures and dispatches repairs via a Python agent

[![CI](https://github.com/Coding-Autopilot-System/ci-autopilot/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Coding-Autopilot-System/ci-autopilot/actions/workflows/ci.yml)
[![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

## Overview

ci-autopilot is an AI-powered CI repair agent that monitors GitHub Actions workflows, detects failures, triages them via an issue queue, and dispatches autonomous repairs using a Python agent backed by Codex. It runs on a self-hosted runner and coordinates the full lifecycle from failure detection to merged fix.
`ci-autopilot` packages the worker/runtime side of the platform. It monitors GitHub Actions workflows, detects failures, triages them via an issue queue, and dispatches autonomous repairs using a Python agent backed by Codex. It runs on a self-hosted runner and provides the execution path from queued repair task to proposed fix.

@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 Avoid claiming the worker produces proposed fixes

The new boundary wording says this repository provides an execution path from a queued task to a proposed fix, but agent/poll_once.py only lists queued issues and exits; it neither invokes Codex nor creates or proposes a fix. This overstates the currently implemented worker behavior and will mislead readers evaluating or operating the repository.

Useful? React with 👍 / 👎.


The agent (`agent/poll_once.py`) is a Python 3.12 stdlib-only program that polls the issue queue, picks up queued repair tasks, and dispatches them to the Codex repair pipeline. No external dependencies are required.

## Repo boundary

- `autopilot-core` is the control plane for org-level scheduling, rollout, and PR governance.
- `ci-autopilot` is the worker/runtime implementation for runner execution, queue polling, and repair dispatch.
- `autopilot-demo` is the demonstration target used to show the runtime and control plane working together.

## Architecture

```mermaid
Expand All @@ -25,12 +31,19 @@ flowchart LR

**Core components:**

- **autopilot-failure-intake.yml** — Intake workflow triggered on `workflow_run` failure events; creates a queued issue
- **autopilot-create-issue.yml** — Creates GitHub issues via `actions/github-script` when monitored workflows fail
- **fixer.yml** — Main CI autopilot; runs `agent/poll_once.py` on the self-hosted Windows runner
- **agent/poll_once.py** — Python 3.12 stdlib agent; polls the issue queue and dispatches repairs
- **runner-smoke-test.yml** — Smoke tests the self-hosted runner on demand
- **runner-health.yml** — Manual runner health check (dispatch only)
- **autopilot-failure-intake.yml** - Intake workflow triggered on `workflow_run` failure events; creates a queued issue
- **autopilot-create-issue.yml** - Creates GitHub issues via `actions/github-script` when monitored workflows fail
- **fixer.yml** - Main CI autopilot; runs `agent/poll_once.py` on the self-hosted Windows runner
- **agent/poll_once.py** - Python 3.12 stdlib agent; polls the issue queue and dispatches repairs
- **runner-smoke-test.yml** - Smoke tests the self-hosted runner on demand
- **runner-health.yml** - Manual runner health check (dispatch only)

## Enterprise proof points

- Deliberately small runtime surface: Python 3.12 stdlib-only agent for easier audit and rebuild.
- Clear separation of concerns: issue intake and governance stay in the control plane; repair execution stays on the worker.
- Self-hosted runner model supports enterprise network boundaries, managed toolchains, and least-privilege token handling.
- Queue-driven processing creates an auditable handoff between CI failure detection and agent action.

## Quick Start

Expand All @@ -42,6 +55,12 @@ python -m agent.poll_once

For full runner registration, service setup, and local development instructions see the [Setup Guide](https://github.com/Coding-Autopilot-System/ci-autopilot/wiki/Setup-Guide) wiki page.

## Runbook path

1. Read [docs/control-plane.md](docs/control-plane.md) for the issue-queue contract with `autopilot-core`.

@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 Point the runbook at an actual autopilot-core contract

This step describes docs/control-plane.md as the issue-queue contract with autopilot-core, but that document never mentions autopilot-core or defines any cross-repository contract; it only summarizes this repository's own intake pipeline and labels. Readers following the new runbook therefore cannot obtain the promised integration information from the linked document.

Useful? React with 👍 / 👎.

2. Use [docs/runner-setup.md](docs/runner-setup.md) to provision the worker host.
3. Use [docs/operations.md](docs/operations.md) and [docs/troubleshooting.md](docs/troubleshooting.md) for day-2 support.

## Documentation

| Source | Description |
Expand All @@ -51,10 +70,11 @@ For full runner registration, service setup, and local development instructions
| [docs/operations.md](docs/operations.md) | Day-2 operations runbook |
| [docs/security.md](docs/security.md) | Security posture and access model |
| [docs/control-plane.md](docs/control-plane.md) | Failure intake and issue control plane |
| [docs/troubleshooting.md](docs/troubleshooting.md) | Lightweight troubleshooting guide |
| [GitHub Pages](https://coding-autopilot-system.github.io/ci-autopilot/) | Professional docs landing page |

**Wiki:** [Home](https://github.com/Coding-Autopilot-System/ci-autopilot/wiki/Home) | [Setup Guide](https://github.com/Coding-Autopilot-System/ci-autopilot/wiki/Setup-Guide) | [Architecture](https://github.com/Coding-Autopilot-System/ci-autopilot/wiki/Architecture) | [Configuration Reference](https://github.com/Coding-Autopilot-System/ci-autopilot/wiki/Configuration-Reference)

## Ecosystem

Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) ecosystem: [gsd-orchestrator](https://github.com/Coding-Autopilot-System/gsd-orchestrator) | [Promptimprover](https://github.com/Coding-Autopilot-System/Promptimprover) | [autogen](https://github.com/Coding-Autopilot-System/autogen)
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) ecosystem alongside the adjacent autopilot repos: [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core) | [autopilot-demo](https://github.com/Coding-Autopilot-System/autopilot-demo)
8 changes: 8 additions & 0 deletions memory/examples/20260610_ci-autopilot_boundary-readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# 20260610_ci-autopilot_boundary-readme

Issue Description: README overlapped with neighboring repos and undersold the worker/runtime role.
State: It was not explicit enough that this repo is the runner-side execution path.
Action: Added repo boundary language, enterprise proof points, and a short runbook path in `README.md`.
Result: The repo now reads as the worker/runtime implementation instead of a generic platform overview.
Diff Patch: Updated `README.md` only.
Rationale: Portfolio readers need a fast distinction between governance/control plane and runner-hosted execution.
Loading