Skip to content

Commit 707c313

Browse files
committed
(ELI-466) english usage
1 parent 722384e commit 707c313

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

DEPLOYMENT.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This repo uses GitHub Actions to deploy through four environments:
44

55
- **Dev** – continuous integration deploys on push to `main`. Creates a `Dev-<timestamp>` tag.
6-
- **test** – Auto deploys the same sha that just deployed to dev (but waits for approval). No releases or SemVer tags.
7-
- **Preprod** – Auto deploys the same sha that just deployed to test (but waits for approval) **cuts/bumps a Release Candidate (RC)** tag (`vX.Y.Z-rc.N`) and creates a **GitHub pre-release**.
6+
- **test** – Auto deploys the same commit that just deployed to Dev (but waits for approval). No releases or SemVer tags.
7+
- **Preprod** – Auto deploys the commit sha that just deployed to test (but waits for approval) **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:
@@ -16,13 +16,13 @@ Releases are immutable and auditable:
1616

1717
## Workflow Map
1818

19-
| Stage | Workflow file | Trigger | What it does | Tags / Releases |
20-
|------------------|-------------------------------------------------------------------------|---------------------------------------|-------------------------------------------------------------------|---------------------------------------------|
21-
| **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 |
23-
| **Test** | `.github/workflows/cicd-3-test.yml` | Auto (`workflow_run`) | Deploys the sha from the run that triggered it | No tags, no releases |
24-
| **Preprod** | `.github/workflows/cicd-4-Preprod-deploy.yml` → calls `base-deploy.yml` | Auto (`workflow_run`) | Deploys the same sha and **creates/bumps an RC tag**; pre-release | `vX.Y.Z-rc.N` + GitHub **pre-release** |
25-
| **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** |
19+
| Stage | Workflow file | Trigger | What it does | Tags / Releases |
20+
|------------------|-------------------------------------------------------------------------|---------------------------------------|------------------------------------------------------------------|---------------------------------------------|
21+
| **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 |
23+
| **Test** | `.github/workflows/cicd-3-test.yml` | Auto (`workflow_run`) | Deploys the commit from the run that triggered it | No tags, no releases |
24+
| **Preprod** | `.github/workflows/cicd-4-Preprod-deploy.yml` → calls `base-deploy.yml` | Auto (`workflow_run`) | Deploys the same commit **creates/bumps an RC tag**; pre-release | `vX.Y.Z-rc.N` + GitHub **pre-release** |
25+
| **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

2727
> **Note:** The Preprod/prod entry workflows are thin wrappers around a **reusable** workflow (`base-deploy.yml`).
2828
@@ -58,7 +58,7 @@ Releases are immutable and auditable:
5858
- Creates a timestamped **Dev tag**: `Dev-YYYYMMDDHHMMSS`
5959
- No SemVer, no GitHub Release.
6060

61-
- Can be manually deployed to flow a candidate though piepline outside of merge
61+
- Can be manually deployed to flow a candidate though pipeline outside of merge
6262

6363
**Why:** fast feedback and a stable pointer (the Dev tag) you can later promote to **test** or use as the **Preprod ref**.
6464

@@ -90,7 +90,7 @@ Releases are immutable and auditable:
9090

9191
- If Auto then no inputs needed at this point
9292
- Auto will determine the release type from the label given to the PR linked to the commit being promoted
93-
- If no Label is given it defaults to rc
93+
- If no Label is given it defaults to release candidate
9494
- If Manual:
9595
- **`ref`**: branch/tag/SHA to deploy (`Dev-<timestamp>` tag).
9696
- **`release_type`**: one of:

0 commit comments

Comments
 (0)