Before a release


Introduction

Before you release the CLI or the framework, walk Getting Started and the tutorials end to end. Unit tests check commands one at a time, while a reader runs them in sequence in a new workspace. That path breaks in ways unit tests miss, such as an undeclared dependency, a new prompt or a step that fails only after the one before it.

cd splent_docs
python3 e2e/run.py --cli ../splent_cli --framework ../splent_framework

The runner creates a new workspace and follows Getting Started and Tutorials 1 to 7, with the commands, files and expected output taken from the pages themselves. It reports each section as passed, failed or skipped, exits 1 if any failed, and keeps a full log.


Running it before a release

  1. Test what you are about to release. --cli and --framework take a local clone, which uses its HEAD (commit first), or a forge ref. With neither, it tests main of the forge.
  2. Include Tutorial 8 when the Claude Code plugin changed. --with-claude runs it, which calls Claude and costs tokens. Pass --claude-plugin ../splent_claude to test your local checkout.
  3. Release only on a clean pass. When a section fails, fix the code, or the page if the code is right. Then run that section again with --root <run dir> --from <section>.
  4. Update the version lines after the release. The run notes when Getting Started shows older versions than the ones under test.

A full run takes about 12 minutes with Docker’s cache warm.

Only one workspace can use the tutorials’ container names at a time, so stop your own my_first_app first. The runner refuses otherwise and names what is in the way. --clean-conflicts removes those containers and their volumes, with their data, so use it only on a workspace you can throw away.


Options

Option Does
--cli, --framework What to test, a local clone or a forge ref
--root <dir> Where the run lives. Default ~/Escritorio/splent_e2e_<date>_<time>. Each run needs a new one
--from <section>, --to <section> The first and last section to run
--from-step <id> With --from, start inside the section
--with-claude, --claude-plugin <dir> Run Tutorial 8, with a local plugin checkout
--keep Leave the environment up at the end
--keep-going Carry on after a failed section
--clean-conflicts Remove the containers and volumes in the way

How pages are marked for the runner, and how output is compared, is in e2e/README.md in the docs repository.


Back to top

splent. Distributed by an LGPL license v3. Contact us: drorganvidez@us.es