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: .github/DEPLOYMENT_README.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
5
5
## Workflows Overview
6
6
7
7
### 1. dev_sandbox_publish_deploy.yaml
8
+
8
9
-**Triggers:** On push to `main` branch.
9
10
-**Environments:** Dev (internal-dev), Sandbox.
10
11
-**Steps:**
@@ -16,6 +17,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
16
17
- Notifies a Slack channel on completion.
17
18
18
19
### 2. preprod_publish_deploy.yaml
20
+
19
21
-**Triggers:** Manually via GitHub UI (`workflow_dispatch`).
20
22
-**Inputs:** Tag to promote (defaults to latest).
21
23
-**Environment:** Preprod.
@@ -26,6 +28,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
26
28
- Deploys the spec to the Preprod Proxygen instance.
27
29
28
30
### 3. prod_publish_deploy.yaml
31
+
29
32
-**Triggers:** Manually via GitHub UI (`workflow_dispatch`).
30
33
-**Inputs:** Tag to promote (required).
31
34
-**Environment:** Prod.
@@ -39,6 +42,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
39
42
## How to Use
40
43
41
44
### Dev & Sandbox Deployment
45
+
42
46
- Push changes to the `main` branch.
43
47
- The workflow will automatically:
44
48
- Deploy to Dev and Sandbox.
@@ -47,20 +51,23 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
47
51
- Notify Slack.
48
52
49
53
### Preprod Deployment
54
+
50
55
- Go to the **Actions** tab in GitHub.
51
56
- Select **Deploy to Preprod** workflow.
52
57
- Click **Run workflow**.
53
58
- Enter the tag to promote (or use the default `latest`).
54
59
- The workflow will deploy the specified tag to Preprod.
55
60
56
61
### Prod Deployment
62
+
57
63
- Go to the **Actions** tab in GitHub.
58
64
- Select **Deploy to Prod** workflow.
59
65
- Click **Run workflow**.
60
66
- Enter the tag to promote (must match a tag from previous deployments).
61
67
- The workflow will deploy the specified tag to Prod and create a GitHub Release.
62
68
63
69
## Notes
70
+
64
71
- All workflows require secrets to be set in the repository (e.g., `PROXYGEN_PRIVATE_KEY`, `POSTMAN_API_KEY`, `SLACK_WORKFLOW_WEBHOOK_URL`, `GITHUB_TOKEN`).
65
72
- The tags created follow the format `spec-YYYYMMDDHHMMSS` indicative of the deployment time. This is NOT related to the [specification/eligibility-signposting-api](../specification/eligibility-signposting-api.yaml) version.
66
73
- For more details, see the steps in each workflow YAML file.
0 commit comments