Skip to content

Commit bce4f57

Browse files
committed
ELI-338: Fixing vale
1 parent ca3edd0 commit bce4f57

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

.github/DEPLOYMENT_README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# GitHub Workflows for eligibility-signposting-api-specification
22

3-
This directory contains GitHub Actions workflows that automate CI/CD processes for the eligibility-signposting-api-specification project. These workflows manage deployment, tagging, and notifications for different environments (Dev, Sandbox, Preprod, Prod) and integrate with external tools like Proxygen and Postman.
3+
This directory contains GitHub Actions workflows that automate CI/CD processes for the eligibility-signposting-api-specification project. These workflows manage deployment, tagging, and notifications for different environments (dev, sandbox, Preprod, Prod) and integrate with external tools like proxygen and Postman.
44

55
## Workflows Overview
66

77
### 1. dev_sandbox_publish_deploy.yaml
88

99
- **Triggers:** On push to `main` branch.
10-
- **Environments:** Dev (APIM: internal dev), Sandbox.
10+
- **Environments:** dev, sandbox.
1111
- **Steps:**
1212
- Sets a version tag based on the current timestamp.
1313
- Installs dependencies (Python, Node.js, Poetry, proxygen-cli).
14-
- Generates and publishes OpenAPI specs to Proxygen for Dev and Sandbox.
14+
- Generates and publishes OpenAPI specs to proxygen for dev and sandbox.
1515
- Publishes the Postman collection to Postman.
1616
- Tags the deployment in Git (Example tag: spec-20260122155331).
1717
- Notifies a Slack channel on completion.
@@ -24,8 +24,8 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
2424
- **Steps:**
2525
- Checks out the specified tag.
2626
- Installs dependencies.
27-
- Generates and publishes the OpenAPI spec to Proxygen for Preprod.
28-
- Deploys the spec to the Preprod Proxygen instance.
27+
- Generates and publishes the OpenAPI spec to proxygen for Preprod.
28+
- Deploys the spec to the Preprod proxygen instance.
2929

3030
### 3. prod_publish_deploy.yaml
3131

@@ -35,17 +35,17 @@ This directory contains GitHub Actions workflows that automate CI/CD processes f
3535
- **Steps:**
3636
- Checks out the specified tag.
3737
- Installs dependencies.
38-
- Generates and publishes the OpenAPI spec to Proxygen for Prod.
39-
- Deploys the spec to the Prod Proxygen instance.
38+
- Generates and publishes the OpenAPI spec to proxygen for Prod.
39+
- Deploys the spec to the Prod proxygen instance.
4040
- Creates a GitHub Release for the deployed tag.
4141

4242
## How to Use
4343

44-
### Dev & Sandbox Deployment
44+
### dev & sandbox Deployment
4545

4646
- Push changes to the `main` branch.
4747
- The workflow will automatically:
48-
- Deploy to Dev and Sandbox.
48+
- Deploy to dev and sandbox.
4949
- Publish the Postman collection.
5050
- Tag the deployment.
5151
- Notify Slack.

0 commit comments

Comments
 (0)