DOCUMENT OPS

Run the README quickstart against each GitLab release and comment the result

When a release tag is pushed in GitLab, runs the README quickstart end to end against the tagged build and comments a pass/fail report on the associated merge request.

CategoryDocument Ops
Enginesim
Difficultyintermediate
Triggerevent
Steps5
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerRelease tag pushed in GitLabGitLabGitLab
  • ActionCheck out tagged commit and extract quickstart blocksGitLabGitLab
  • ActionRun quickstart sequentially in a sandboxShell
  • LogicPass or fail from combined exit status
  • OutputComment the verdict on the release MRGitLabGitLab

What it does

Makes the README quickstart a release-time acceptance test. On a new GitLab tag, it checks out exactly that revision, runs the documented quickstart as a real user would, and writes the outcome back as a merge request comment so a broken first-run experience can't ride out in a release.

When to use it

Use it for projects released on GitLab where the README quickstart is the contract with new users. Especially valuable when releases bundle dependency or API changes that can break the very first example.

How it works

  1. 1A tag push (release) event fires in GitLab.
  2. 2The workflow checks out the tagged commit into a clean sandbox.
  3. 3It extracts the quickstart code blocks from the README in order.
  4. 4It runs them as a single sequential script in the sandboxed shell, capturing exit codes and output.
  5. 5A branch decides pass or fail from the combined exit status.
  6. 6It posts a formatted comment on the release's merge request with the verdict and, on failure, the first error encountered.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitLabRepos, MRs, pipelines, registry.
  2. 2
    Connect ShellRun sandboxed commands inside the workspace.
  3. 3
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  4. 4
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  5. 5
    Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.

Run this workflow in your colony.

14-day trial. No DevOps. No Sales call. Provisioned in under a minute.