Skip to content

Docs: CI usage example with JSON reports #6

Description

@guohuancui123-a11y

Goal

Add a small CI example showing how RepairLoop can be used as an automation primitive.

Why

RepairLoop is useful in terminals, but JSON reports make it especially interesting for CI and agent workflows. A simple example would help users understand how to integrate it safely.

Proposed content

  • A minimal GitHub Actions example.
  • A command using repair-loop repair --json-report -- <command>.
  • A short explanation of preview mode vs --apply.
  • A warning that CI auto-apply should be used only in trusted, controlled repositories.

Acceptance criteria

  • Add a docs page or README section with the CI example.
  • Example command is copy-pasteable.
  • The example keeps dry-run as the default.
  • Link the example from README.

Safety notes

Do not encourage blind auto-committing of generated repairs. CI usage should emphasize inspection and controlled apply behavior.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomersroadmapPlanned RepairLoop roadmap work

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions