Skip to content

Test evidence & CI

Handover deliverables lists test reports as an expected artifact. This page standardizes where evidence lives and which commands produce it, without storing secrets or transient output in git.

Typical command (exact targets depend on your hooks.py test configuration):

Terminal window
# From Bench root, with site context
bench --site <site> run-tests --app leekimerp

Capture for handover: stdout/stderr log, date, Bench/Frappe/ERPNext versions from bench version, and git SHA.

The repository includes a workflow that builds the docs when docs/** changes (see .github/workflows/deploy-docs.yml in the repo root). Evidence: successful GitHub Actions run for the commit being handed over.

ItemValue / note
Workflow file.github/workflows/deploy-docs.yml
Workflow name (Actions UI)Docs — build (Cloudflare-ready)
Job idbuild (single job)
Triggerspush / pull_request when docs/**, leekimerp/**/doctype/**/*.json, or this workflow changes; also workflow_dispatch
PR gateSame workflow runs on PRs — a green run is the minimum merge signal for doc-only changes
Build artifact namedocs-dist-client (contents: docs/dist/client)
Artifact retentionGitHub repository/org default (often 90 days; confirm in Settings → Actions → General if your policy differs)
Cloudflare PagesStep uses cloudflare/pages-action when secrets are configured — production URL is org-specific

Adjust the retention column in your runbook if the org pins a non-default retention policy.

ArtifactFormatNotes
Unit / integration logText or PDF export from CIRedact connection strings
Coverage (if enabled)HTML or CI summaryOptional
Manual smoke testShort checklistLogin, create doc, integration ping in UAT
  • Attach CI run URLs to your ticket or handover folder.
  • Do not embed production database dumps in documentation.