Git, release & deploy docs¶
Team process home for branching, release, deployment, and rollback. Source of truth is this folder (Markdown in git, changed via PR). Do not treat GitHub Wiki or Confluence as canonical.
Audience: every BookingZone developer and AI coding agent
Owner: Platform / DevOps
Tracking: Epic G #61 · Project #5
Start here¶
| Doc | When to read |
|---|---|
| Branching | Which branch to cut; TASK-{id} naming; PR targets |
| Release strategy | How code becomes a versioned release |
| Deployment strategy | DEV/PROD ship paths (Actions vs CodePipeline/Amplify) |
| Rollback strategy | How to undo a bad deploy safely |
| Hygiene & enforcement | ff-only, hooks, branch protection, recovery |
Day-to-day ship checklist: ../SDLC-RUNBOOK.md
Channel contracts (preview vs stable): ../../specs/SYS-003-develop-main-integration-model/spec.md
Mandatory: task before branch¶
- Ensure a GitHub Issue exists on the relevant Project (#1, #4, or #5).
- Only then create a branch:
Example: feature/TASK-62-git-process-docs
- Implement only on that branch; open a PR that links the issue (
Closes #NNN).
CI will reject PRs whose head branch lacks TASK-{id} (see #74).
Approved model (one picture)¶
feature/TASK-* ← develop
│ optional manual workflow → shared DEV
▼
PR → develop (required CI)
│
▼
release/x.y.z ← develop
│ manual workflow → PROD (confirm required)
▼
PR → main (after prod validation)
│
▼
auto: tag vX.Y.Z + GitHub Release
- GitHub Actions = quality gates (+ optional manual deploy orchestration)
- CodePipeline / Amplify = actual ship
- Push alone never deploys (target — Epic F)
bz-platform-contextitself usesmainas default; application repos followdevelop/release/*/mainas above.
Wiki / Sites¶
| Option | Role |
|---|---|
docs/git/*.md (this repo) |
Primary source of truth |
GitHub Pages from docs/ |
Optional later viewer |
| GitHub Wiki / Confluence | Mirror only — never canonical |
Legacy¶
Older planning detail remains in ../GIT-WORKFLOW.md.
Prefer this folder for day-to-day reading.