Skip to content

Commit ee04bbc

Browse files
committed
spelling
1 parent 07bb6e6 commit ee04bbc

File tree

2 files changed

+29
-32
lines changed

2 files changed

+29
-32
lines changed

DEPLOYMENT.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
This repo uses GitHub Actions to deploy through four environments:
44

5-
- **dev** – continuous integration deploys on push to `main`. Creates a `dev-<timestamp>` tag.
6-
- **test** – manual deploy of an existing tag (usually a `dev-<timestamp>` tag). No releases or SemVer tags.
7-
- **preprod** – manual deploy that **cuts/bumps a Release Candidate (RC)** tag (`vX.Y.Z-rc.N`) and creates a **GitHub pre-release**.
5+
- **Dev** – continuous integration deploys on push to `main`. Creates a `Dev-<timestamp>` tag.
6+
- **test** – manual deploy of an existing tag (usually a `Dev-<timestamp>` tag). No releases or SemVer tags.
7+
- **Preprod** – manual deploy that **cuts/bumps a Release Candidate (RC)** tag (`vX.Y.Z-rc.N`) and creates a **GitHub pre-release**.
88
- **prod** – manual promotion of a specific RC to a **final SemVer tag** (`vX.Y.Z`) and a **GitHub Release**.
99

1010
Releases are immutable and auditable:
1111

12-
- **RC tags** live only in preprod.
12+
- **RC tags** live only in Preprod.
1313
- **Final tags** (`vX.Y.Z`) live only in prod and point to the exact commit that shipped.
1414

1515
---
@@ -19,12 +19,12 @@ Releases are immutable and auditable:
1919
| Stage | Workflow file | Trigger | What it does | Tags / Releases |
2020
|------------------|-------------------------------------------------------------------------|---------------------------------------|-----------------------------------------------------------------|---------------------------------------------|
2121
| **Pull Request** | `.github/workflows/cicd-1-pull-request.yml` | `pull_request` (opened/sync/reopened) | Commit/Test/Build/Acceptance stages | No tags/releases |
22-
| **Dev** | `.github/workflows/cicd-2-publish.yml` | `push` to `main` | Builds & deploys to dev | Creates and pushes `dev-YYYYMMDDHHMMSS` tag |
22+
| **Dev** | `.github/workflows/cicd-2-publish.yml` | `push` to `main` | Builds & deploys to Dev | Creates and pushes `Dev-YYYYMMDDHHMMSS` tag |
2323
| **Test** | `.github/workflows/cicd-3-test.yml` | Manual (`workflow_dispatch`) | Deploys the chosen tag to test | No tags, no releases |
24-
| **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+
| **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** |
2525
| **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** |
2626

27-
> **Note:** The preprod/prod entry workflows are thin wrappers around a **reusable** workflow (`base-deploy.yml`).
27+
> **Note:** The Preprod/prod entry workflows are thin wrappers around a **reusable** workflow (`base-deploy.yml`).
2828
2929
---
3030

@@ -47,11 +47,11 @@ Releases are immutable and auditable:
4747
**File:** `CI/CD publish`
4848
**Trigger:** push to `main`
4949

50-
- Builds & deploys to **dev**.
51-
- Creates a timestamped **dev tag**: `dev-YYYYMMDDHHMMSS`
50+
- Builds & deploys to **Dev**.
51+
- Creates a timestamped **Dev tag**: `Dev-YYYYMMDDHHMMSS`
5252
- No SemVer, no GitHub Release.
5353

54-
**Why:** fast feedback and a stable pointer (the dev tag) you can later promote to **test** or use as the **preprod ref**.
54+
**Why:** fast feedback and a stable pointer (the Dev tag) you can later promote to **test** or use as the **Preprod ref**.
5555

5656
---
5757

@@ -62,7 +62,7 @@ Releases are immutable and auditable:
6262

6363
### Inputs
6464

65-
- `tag`: the ref to deploy (e.g., a **dev** tag created by the dev workflow).
65+
- `tag`: the ref to deploy (e.g., a **Dev** tag created by the Dev workflow).
6666
- `environment`: fixed to `test`.
6767

6868
### Behavior
@@ -72,18 +72,18 @@ Releases are immutable and auditable:
7272

7373
### Recommended usage
7474

75-
- Deploy the **same commit** that was verified in dev by supplying the `dev-<timestamp>` tag here.
75+
- Deploy the **same commit** that was verified in Dev by supplying the `Dev-<timestamp>` tag here.
7676

7777
---
7878

7979
## Preprod (Release Candidates)
8080

81-
**Entry workflow:** `cicd-4-preprod-deploy.yml` → calls `base-deploy.yml`
81+
**Entry workflow:** `cicd-4-Preprod-deploy.yml` → calls `base-deploy.yml`
8282
**Trigger:** manual (`workflow_dispatch`)
8383

8484
### Inputs
8585

86-
- **`ref`**: branch/tag/SHA to deploy (`dev-<timestamp>` tag).
86+
- **`ref`**: branch/tag/SHA to deploy (`Dev-<timestamp>` tag).
8787
- **`release_type`**: one of:
8888
- `patch` – start a new **patch** series → `vX.Y.(Z+1)-rc.1`
8989
- `minor` – start a new **minor** series → `vX.(Y+1).0-rc.1`
@@ -93,7 +93,7 @@ Releases are immutable and auditable:
9393
### Behavior
9494

9595
- Tags the **checked-out commit** as the next **RC** (`vX.Y.Z-rc.N`) and pushes it.
96-
- Deploys to **preprod**.
96+
- Deploys to **Preprod**.
9797
- Creates a **GitHub pre-release** for that RC.
9898

9999
### When to use which `release_type`
@@ -125,40 +125,40 @@ Releases are immutable and auditable:
125125

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

136136
---
137137

138138
## Versioning Rules
139139

140-
- **Dev tags**: `dev-YYYYMMDDHHMMSS` (automation convenience; never promoted to prod directly).
141-
- **RC tags**: `vX.Y.Z-rc.N` (preprod only; immutable; one per candidate).
140+
- **Dev tags**: `Dev-YYYYMMDDHHMMSS` (automation convenience; never promoted to prod directly).
141+
- **RC tags**: `vX.Y.Z-rc.N` (Preprod only; immutable; one per candidate).
142142
- **Final tags**: `vX.Y.Z` (prod only; immutable; exactly what shipped).
143143

144144
### Promotion path
145145

146-
- Choose a commit (often via a **dev tag**) → cut RC(s) in **preprod** → promote the selected RC to **prod**.
146+
- Choose a commit (often via a **Dev tag**) → cut RC(s) in **Preprod** → promote the selected RC to **prod**.
147147

148148
---
149149

150150
## Common Q&A
151151

152-
**Can I use a dev tag as the preprod `ref`?**
153-
Yes. `ref` can be any branch/tag/SHA. Using a `dev-<timestamp>` tag guarantees you deploy the **same commit** previously built on dev.
152+
**Can I use a Dev tag as the Preprod `ref`?**
153+
Yes. `ref` can be any branch/tag/SHA. Using a `Dev-<timestamp>` tag guarantees you deploy the **same commit** previously built on Dev.
154154

155155
**What does `rc` mean?**
156156
**Release Candidate**: a build that could become the final version if it passes testing. Each new candidate for the same base version increments the suffix: `-rc.1`, `-rc.2`, …
157157

158-
**What if I already have `v1.4.0-rc.1` and I need another preprod build for the same release?**
158+
**What if I already have `v1.4.0-rc.1` and I need another Preprod build for the same release?**
159159
Run **Preprod Deploy** with `release_type=rc` to get `v1.4.0-rc.2`.
160160

161-
**What if I discover issues after preprod?**
161+
**What if I discover issues after Preprod?**
162162
Fix, then cut a new RC (`-rc.N+1`). Only promote to prod when ready.
163163

164164
---
@@ -167,8 +167,8 @@ Fix, then cut a new RC (`-rc.N+1`). Only promote to prod when ready.
167167

168168
### New minor release
169169

170-
1. Dev (auto) → creates `dev-20250818…`.
171-
2. Preprod (manual) → `ref=dev-20250818…`, `release_type=minor``v1.4.0-rc.1`.
170+
1. Dev (auto) → creates `Dev-20250818…`.
171+
2. Preprod (manual) → `ref=Dev-20250818…`, `release_type=minor``v1.4.0-rc.1`.
172172
3. Preprod (manual) → `release_type=rc``v1.4.0-rc.2`.
173173
4. Prod (manual) → `ref=v1.4.0-rc.2` → final `v1.4.0`.
174174

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ Pydantic
3030
yanai
3131
Portman
3232
repo
33-
dev
3433
Preprod
3534
Dev
3635
auditable
37-
DEV
38-
preprod

0 commit comments

Comments
 (0)