Skip to content

Commit 58a250a

Browse files
committed
ELI-338: Fixes 'English' and 'Markdown'
1 parent 654ce7f commit 58a250a

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

.github/DEPLOYMENT_README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
55
## Workflows Overview
66

77
### 1. dev_sandbox_publish_deploy.yaml
8+
89
- **Triggers:** On push to `main` branch.
910
- **Environments:** Dev (internal-dev), Sandbox.
1011
- **Steps:**
@@ -16,6 +17,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
1617
- Notifies a Slack channel on completion.
1718

1819
### 2. preprod_publish_deploy.yaml
20+
1921
- **Triggers:** Manually via GitHub UI (`workflow_dispatch`).
2022
- **Inputs:** Tag to promote (defaults to latest).
2123
- **Environment:** Preprod.
@@ -26,6 +28,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
2628
- Deploys the spec to the Preprod Proxygen instance.
2729

2830
### 3. prod_publish_deploy.yaml
31+
2932
- **Triggers:** Manually via GitHub UI (`workflow_dispatch`).
3033
- **Inputs:** Tag to promote (required).
3134
- **Environment:** Prod.
@@ -39,6 +42,7 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
3942
## How to Use
4043

4144
### Dev & Sandbox Deployment
45+
4246
- Push changes to the `main` branch.
4347
- The workflow will automatically:
4448
- Deploy to Dev and Sandbox.
@@ -47,20 +51,23 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
4751
- Notify Slack.
4852

4953
### Preprod Deployment
54+
5055
- Go to the **Actions** tab in GitHub.
5156
- Select **Deploy to Preprod** workflow.
5257
- Click **Run workflow**.
5358
- Enter the tag to promote (or use the default `latest`).
5459
- The workflow will deploy the specified tag to Preprod.
5560

5661
### Prod Deployment
62+
5763
- Go to the **Actions** tab in GitHub.
5864
- Select **Deploy to Prod** workflow.
5965
- Click **Run workflow**.
6066
- Enter the tag to promote (must match a tag from previous deployments).
6167
- The workflow will deploy the specified tag to Prod and create a GitHub Release.
6268

6369
## Notes
70+
6471
- All workflows require secrets to be set in the repository (e.g., `PROXYGEN_PRIVATE_KEY`, `POSTMAN_API_KEY`, `SLACK_WORKFLOW_WEBHOOK_URL`, `GITHUB_TOKEN`).
6572
- 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.
6673
- For more details, see the steps in each workflow YAML file.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ Terraform
2525
toolchain
2626
Trufflehog
2727
uat
28+
Dev
29+
Preprod

0 commit comments

Comments
 (0)