Files
notifications-api/docs/deploying.md
2022-11-02 11:36:54 -04:00

1.5 KiB

Deploying

We deploy automatically to cloud.gov for demo and staging environments.

Deployment to staging runs via the base deployment action on GitHub, which pulls credentials from GitHub's secrets store in the staging environment.

Deployment to demo runs via the demo deployment action on GitHub, which pulls credentials from GitHub's secrets store in the demo environment.

The action that we use deploys using a rolling strategy, so all deployments should have zero downtime.

The API has 2 deployment environments:

  • Staging, which deploys from main
  • Demo, which deploys from production

In the future, we will add a Production deploy environment, which will deploy in parallel to Demo.

Configurations for these are located in the deploy-config folder.

In the event that a deployment includes a Terraform change, that change will run before any code is deployed to the environment. Each environment has its own Terraform GitHub Action to handle that change.

Failures in any of these GitHub workflows will be surfaced in the Pull Request related to the code change, and in the case of checks.yml actively prevent the PR from being merged. Failure in the Terraform workflow will not actively prevent the PR from being merged, but reviewers should not approve a PR with a failing terraform plan.