Skip to content

Execute the registryctl tutorials end to end in CI #212

Description

@jeremi

Part of the 1.0 release-readiness push (see release/READINESS.md, section 1).

Context

docs/site/scripts/check-tutorial.sh executes only the monorepo lab tutorial (first-run-with-registry-lab) end to end. The two registryctl tutorials, which are the actual adopter first-run path (publish-spreadsheet-secured-registry-api, verify-claim-registry-api), are covered by a shell-command line-count assertion only (REGISTRYCTL_TUTORIALS, around lines 149-187). A renamed flag, changed error string, or bumped default would pass CI as long as the command count matches. The script's own comment says these are "execution-verified manually".

Scope

  • A CI job (or an extension of check-tutorial.sh) that runs both registryctl tutorials' documented commands against real containers on an amd64 runner, asserting on the documented outputs (PASS lines, HTTP status codes, error codes such as auth.scope_denied).
  • Keep the fast line-count assertion as a cheap pre-gate.
  • Steps that depend on the hosted lab stay out of scope; these two tutorials are fully local.

Acceptance

  • CI fails when a documented tutorial command or its documented output breaks.
  • The job runs on PRs touching the tutorials, registryctl, or the product images (or on a schedule if runtime cost demands it, with the tradeoff recorded).

Security note

If this work surfaces a suspected vulnerability, report it per SECURITY.md; do not post details on this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent-readyReady for an implementation agent.area:docsDocumentation site ownership.documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions