docs/deploying.md

# Deploying

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

Deployment to staging runs via the [base deployment action](../.github/workflows/deploy.yml) on GitHub, which pulls credentials from GitHub's secrets store in the staging environment.

Deployment to demo runs via the [demo deployment action](../.github/workflows/deploy-demo.yml) on GitHub, which pulls credentials from GitHub's secrets store in the demo environment.

The [action that we use](https://github.com/18F/cg-deploy-action) deploys using [a rolling strategy](https://docs.cloudfoundry.org/devguide/deploy-apps/rolling-deploy.html), 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](../deploy-config/).

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.
more ci info 2022-10-28 11:11:17 -04:00			`# Deploying`

Create demo deploy workflows 2022-11-02 09:55:56 -04:00			`We deploy automatically to cloud.gov for demo and staging environments.`
more ci info 2022-10-28 11:11:17 -04:00
Create demo deploy workflows 2022-11-02 09:55:56 -04:00			`Deployment to staging runs via the [base deployment action](../.github/workflows/deploy.yml) on GitHub, which pulls credentials from GitHub's secrets store in the staging environment.`

			`Deployment to demo runs via the [demo deployment action](../.github/workflows/deploy-demo.yml) on GitHub, which pulls credentials from GitHub's secrets store in the demo environment.`
more ci info 2022-10-28 11:11:17 -04:00
			`The [action that we use](https://github.com/18F/cg-deploy-action) deploys using [a rolling strategy](https://docs.cloudfoundry.org/devguide/deploy-apps/rolling-deploy.html), so all deployments should have zero downtime.`

			`The API has 2 deployment environments:`

Create demo deploy workflows 2022-11-02 09:55:56 -04:00			- 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.`
more ci info 2022-10-28 11:11:17 -04:00
			Configurations for these are located in [the `deploy-config` folder](../deploy-config/).

			`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.`

Create demo deploy workflows 2022-11-02 09:55:56 -04:00			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.