You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEPLOYMENT.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@
3
3
This repo uses GitHub Actions to deploy through four environments:
4
4
5
5
-**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**.
8
8
-**prod** – manual promotion of a specific RC to a **final SemVer tag** (`vX.Y.Z`) and a **GitHub Release**.
9
9
10
10
Releases are immutable and auditable:
@@ -16,13 +16,13 @@ Releases are immutable and auditable:
16
16
17
17
## Workflow Map
18
18
19
-
| Stage | Workflow file | Trigger | What it does | Tags / Releases |
|**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 |
|**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**|
26
26
27
27
> **Note:** The Preprod/prod entry workflows are thin wrappers around a **reusable** workflow (`base-deploy.yml`).
28
28
@@ -58,7 +58,7 @@ Releases are immutable and auditable:
58
58
- Creates a timestamped **Dev tag**: `Dev-YYYYMMDDHHMMSS`
59
59
- No SemVer, no GitHub Release.
60
60
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
62
62
63
63
**Why:** fast feedback and a stable pointer (the Dev tag) you can later promote to **test** or use as the **Preprod ref**.
64
64
@@ -90,7 +90,7 @@ Releases are immutable and auditable:
90
90
91
91
- If Auto then no inputs needed at this point
92
92
- 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
94
94
- If Manual:
95
95
-**`ref`**: branch/tag/SHA to deploy (`Dev-<timestamp>` tag).
0 commit comments