Skip to content

Commit bae40d6

Browse files
committed
formatting and english usage
1 parent 2b15ba6 commit bae40d6

2 files changed

Lines changed: 22 additions & 16 deletions

File tree

DEPLOYMENT.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Releases are immutable and auditable:
1515

1616
## Workflow Map
1717

18-
| Stage | Workflow file | Trigger | What it does | Tags / Releases |
19-
|------|-------------------------------------------------------------------------|---------|--------------|-----------------|
20-
| **Pull Request** | `.github/workflows/cicd-1-pull-request.yml` | `pull_request` (opened/sync/reopened) | Commit/Test/Build/Acceptance stages | No tags/releases |
21-
| **Dev** | `.github/workflows/cicd-2-publish.yml` | `push` to `main` | Builds & deploys to dev | Creates and pushes `dev-YYYYMMDDHHMMSS` tag |
22-
| **Test** | `.github/workflows/cicd-3-test.yml` | Manual (`workflow_dispatch`) | Deploys the chosen tag to test | No tags, no releases |
23-
| **Preprod** | `.github/workflows/cicd-4-preprod-deploy.yml` → calls `base-deploy.yml` | Manual (`workflow_dispatch`) | Deploys chosen ref and **creates/bumps an RC tag**; pre-release | `vX.Y.Z-rc.N` + GitHub **pre-release** |
24-
| **Prod** | `.github/workflows/cicd-5-prod-deploy.yml` → calls `base-deploy.yml` | Manual (`workflow_dispatch`) | Promotes a specific RC to final | `vX.Y.Z` + GitHub **Release** |
18+
| Stage | Workflow file | Trigger | What it does | Tags / Releases |
19+
|------------------|-------------------------------------------------------------------------|---------------------------------------|-----------------------------------------------------------------|---------------------------------------------|
20+
| **Pull Request** | `.github/workflows/cicd-1-pull-request.yml` | `pull_request` (opened/sync/reopened) | Commit/Test/Build/Acceptance stages | No tags/releases |
21+
| **Dev** | `.github/workflows/cicd-2-publish.yml` | `push` to `main` | Builds & deploys to dev | Creates and pushes `dev-YYYYMMDDHHMMSS` tag |
22+
| **Test** | `.github/workflows/cicd-3-test.yml` | Manual (`workflow_dispatch`) | Deploys the chosen tag to test | No tags, no releases |
23+
| **Preprod** | `.github/workflows/cicd-4-preprod-deploy.yml` → calls `base-deploy.yml` | Manual (`workflow_dispatch`) | Deploys chosen ref and **creates/bumps an RC tag**; pre-release | `vX.Y.Z-rc.N` + GitHub **pre-release** |
24+
| **Prod** | `.github/workflows/cicd-5-prod-deploy.yml` → calls `base-deploy.yml` | Manual (`workflow_dispatch`) | Promotes a specific RC to final | `vX.Y.Z` + GitHub **Release** |
2525

2626
> **Note:** The preprod/prod entry workflows are thin wrappers around a **reusable** workflow (`base-deploy.yml`).
2727
@@ -114,15 +114,15 @@ Releases are immutable and auditable:
114114

115115
## Decision Guide (what to pick, when)
116116

117-
| Situation | Workflow | Input: `ref` | Input: `release_type` | Result |
118-
|-----------|----------|--------------|------------------------|--------|
119-
| Deploy automatically after merge to main | **Dev** (auto) | `main` (implicit) | n/a | Deploys to dev, creates `dev-YYYYMMDDHHMMSS` |
120-
| Deploy an existing build to test | **Test** (manual) | a tag (e.g. `dev-20250817…`) | n/a | Deploys to test (no tags/releases) |
121-
| Start a **new patch release** into preprod | **Preprod** (manual) | branch/tag/SHA | `patch` | `vX.Y.(Z+1)-rc.1` + pre-release |
122-
| Start a **new minor release** into preprod | **Preprod** | branch/tag/SHA | `minor` | `vX.(Y+1).0-rc.1` + pre-release |
123-
| Start a **new major release** into preprod | **Preprod** | branch/tag/SHA | `major` | `v(X+1).0.0-rc.1` + pre-release |
124-
| Cut **another candidate** for the **same base** | **Preprod** | branch/tag/SHA (same train) | `rc` | `vX.Y.Z-rc.N+1` + pre-release |
125-
| Promote a **tested RC** to production | **Prod** (manual) | RC tag (e.g. `v1.4.0-rc.2`) | n/a | `v1.4.0` + GitHub Release |
117+
| Situation | Workflow | Input: `ref` | Input: `release_type` | Result |
118+
|-------------------------------------------------|----------------------|------------------------------|-----------------------|----------------------------------------------|
119+
| Deploy automatically after merge to main | **Dev** (auto) | `main` (implicit) | n/a | Deploys to dev, creates `dev-YYYYMMDDHHMMSS` |
120+
| Deploy an existing build to test | **Test** (manual) | a tag (e.g. `dev-20250817…`) | n/a | Deploys to test (no tags/releases) |
121+
| Start a **new patch release** into preprod | **Preprod** (manual) | branch/tag/SHA | `patch` | `vX.Y.(Z+1)-rc.1` + pre-release |
122+
| Start a **new minor release** into preprod | **Preprod** | branch/tag/SHA | `minor` | `vX.(Y+1).0-rc.1` + pre-release |
123+
| Start a **new major release** into preprod | **Preprod** | branch/tag/SHA | `major` | `v(X+1).0.0-rc.1` + pre-release |
124+
| Cut **another candidate** for the **same base** | **Preprod** | branch/tag/SHA (same train) | `rc` | `vX.Y.Z-rc.N+1` + pre-release |
125+
| Promote a **tested RC** to production | **Prod** (manual) | RC tag (e.g. `v1.4.0-rc.2`) | n/a | `v1.4.0` + GitHub Release |
126126

127127
---
128128

scripts/config/vale/styles/config/vocabularies/words/accept.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,9 @@ wireup
2929
Pydantic
3030
yanai
3131
Portman
32+
repo
33+
dev
34+
preprod
35+
Preprod
36+
Dev
37+
auditable

0 commit comments

Comments
 (0)