Skip to content
@setupproof

SetupProof

README quickstart verification for maintainers.

SetupProof

SetupProof tests marked README quickstarts from a clean workspace before contributors hit them.

The main project is setupproof/setupproof.

go install github.com/setupproof/setupproof/cmd/setupproof@v0.1.0
setupproof review README.md
setupproof --require-blocks --no-color --no-glyphs README.md

Use the GitHub Action with a pinned Action tag and CLI version:

- uses: setupproof/setupproof@v0.1.0
  with:
    cli-version: v0.1.0
    require-blocks: "true"
    files: README.md

SetupProof is intentionally narrow: it verifies explicitly marked shell blocks, reports what passed or failed, sends no telemetry, and does not execute unmarked Markdown examples.

Popular repositories Loading

  1. setupproof setupproof Public

    Test marked README quickstarts from a clean workspace before new contributors hit them.

    Go 1 1

  2. .github .github Public

    SetupProof organization profile

Repositories

Showing 2 of 2 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…