Saphan StudioDocs
Reference/Command reference

saphan pr-preflight

Run PR pre-flight checks (branch, status, log, behind-base, submodule, build, scoped-test) and emit a STOP list

saphan pr-preflight

Run PR pre-flight checks (branch, status, log, behind-base, submodule, build, scoped-test) and emit a STOP list

saphan pr-preflight [flags]

Options

OptionTypeDefaultDescription
--basestringunsetbase branch the PR will target, e.g. develop [required]
--branch-patternstringunsetglob the work branch must match, e.g. 'feature/*' (optional)
--build-cmdstringunsetcommand that must build cleanly before a PR [required]
--configstringunsetproject-layer config file (mechanic facts live there, never in the engine)
--subject-patternstringunsetRE2 regexp every commit subject ahead of base must match (optional)
--test-cmdstringunsetscoped test command that must be green before a PR [required]
--workdirstringunsetrepository directory the checks observe (optional)

On this page