Skip to content

Release Checklist

██████╗ ███╗ ██╗███████╗
██╔═══██╗████╗ ██║██╔════╝
██║ ██║██╔██╗ ██║█████╗
██║ ██║██║╚██╗██║██╔══╝
╚██████╔╝██║ ╚████║███████╗
╚═════╝ ╚═╝ ╚═══╝╚══════╝

Full TUI logo artwork

Reproducible commands for verifying the one-agent package before publication. Run from the repository root.

Terminal window
# Activate the virtual environment (already created during setup)
source .venv/bin/activate
Terminal window
python -m pytest -q
Terminal window
python -m ruff check .
Terminal window
python -m build

Produces dist/one-agent-*.tar.gz and dist/one-agent-*.whl.

Terminal window
twine check dist/*
Terminal window
pip check
Terminal window
# Install into a temporary venv from the built wheel
TMPDIR=$(mktemp -d)
python3 -m venv "$TMPDIR/test-env"
. "$TMPDIR/test-env/bin/activate"
python -m pip install --no-deps dist/one-agent-*.whl
# PYTHONPATH must NOT be set so the test resolves the installed package,
# not the source checkout.
env -u PYTHONPATH "$TMPDIR/test-env/bin/python" -c "import one; print(one.config.VERSION)"
env -u PYTHONPATH "$TMPDIR/test-env/bin/python" -c "from one.modes.print_mode import run_print_mode; print('import ok')"
# Same for the sdist (rebuild first, then install)
python -m build --sdist
env -u PYTHONPATH "$TMPDIR/test-env/bin/python" -m pip install --no-deps "$(ls dist/one-agent-*.tar.gz)"
env -u PYTHONPATH "$TMPDIR/test-env/bin/python" -c "import one; print(one.config.VERSION)"
rm -rf "$TMPDIR"
Terminal window
# List all files in the wheel
unzip -l dist/one-agent-*.whl
# List all files in the sdist
tar tzf dist/one-agent-*.tar.gz

Verify archives exclude: tests/, .one/, __pycache__/, .git/, credentials, and any private blobs. Wheels must not contain *.egg-info/; setuptools may include only its generated one_agent.egg-info/SOURCES.txt manifest in the sdist.

Terminal window
# Check the installed version's flag syntax first
gitleaks --help | grep -i redact || gitleaks version
# Full-history redacted scan (output redacted; secrets must never be printed)
gitleaks detect --source . --report-format json --report-path /tmp/gitleaks-report.json
# Inspect only finding types (not raw secrets):
jq '[.[].RuleID] | unique' /tmp/gitleaks-report.json

Note: Syntax (--report-format, --report-path) varies by gitleaks version. Always check gitleaks --help for the exact flags on the installed version.

9. pip-audit — resolved-environment scan

Section titled “9. pip-audit — resolved-environment scan”
Terminal window
# Scan the currently resolved environment.
pip-audit
# If a requirements file is introduced later, scan it explicitly with:
# pip-audit -r requirements.txt
  • Review all third-party licenses in .venv/lib/python*/site-packages/*/LICENSE*
  • Verify test image fixtures (PNG/JPEG/WebP) are self-generated (see _make_png, _make_jpeg in test files) or have permissive licenses
  • Version rule: user-visible changes bump VERSION per AGENTS.md → Versioning (pinned tests, TUI goldens, and CHANGELOG → Unreleased move with it).
  • Secret/history scanning and GitHub security controls remain manual maintainer steps. These are not automated in CI and must be run by an authorized maintainer with the necessary permissions.
  • The ONE_CODING_AGENT_DIR environment variable must point to a scratch dir during tests (every CLI subprocess test uses a tmp_path-backed agent dir).
  • CLI subprocess tests strip all inherited provider API keys via _PROVIDER_KEY_NAMES in tests/test_image_cli_rpc.py.