Skip to content

Commit

Permalink
docs(deployment): update with new GitHub Actions info
Browse files Browse the repository at this point in the history
remove outdated webhook references
  • Loading branch information
thekaveman committed May 25, 2024
1 parent bdde33b commit c67a5b1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
5 changes: 2 additions & 3 deletions docs/deployment/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,10 @@ Use the following shorthand for conveying the Resource Type as part of the Resou
## Azure environment setup
The following steps are required to set up the environment, with linked issues to automate them:
The following steps are required to set up the environment:
- `terraform apply`
- Set up Slack notifications by [creating a Slack email](https://slack.com/help/articles/206819278-Send-emails-to-Slack) for the [#benefits-notify](https://cal-itp.slack.com/archives/C022HHSEE3F) channel, then [setting it as a Secret in the Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/secrets/quick-create-portal#add-a-secret-to-key-vault) named `slack-benefits-notify-email`
- Set up Slack notifications by [creating a Slack email](https://slack.com/help/articles/206819278-Send-emails-to-Slack) for the [#notify-benefits](https://cal-itp.slack.com/archives/C022HHSEE3F) channel, then [setting it as a Secret in the Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/secrets/quick-create-portal#add-a-secret-to-key-vault) named `slack-benefits-notify-email`
- Set required [App Service configuration](../configuration/environment-variables.md) and [configuration](../configuration/data.md) by setting values in Key Vault (the mapping is defined in [app_service.tf](https://github.com/cal-itp/benefits/blob/dev/terraform/app_service.tf))
- [Set up webhook from GitHub](https://github.com/cal-itp/benefits/settings/hooks) to [App Service Deployment Center](https://learn.microsoft.com/en-us/azure/app-service/deploy-ci-cd-custom-container?tabs=acr&pivots=container-linux) for the `Packages` event
This is not a complete step-by-step guide; more a list of things to remember. This may be useful as part of [incident response](https://docs.google.com/document/d/1qtev8qItPiTB4Tp9FQ87XsLtWZ4HlNXqoe9vF2VuGcY/edit#).
5 changes: 2 additions & 3 deletions docs/deployment/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,15 @@ Using the `github.actor` and built-in `GITHUB_TOKEN` secret

### 3. Build and push image to GitHub Container Registry (GHCR)

Build the root [`Dockerfile`][dockerfile], tagging with both the branch name (e.g. `dev`) and the SHA from the HEAD commit.
Build the root [`Dockerfile`][dockerfile], tagging with the SHA from the HEAD commit.

Push this image:tag into [GHCR][ghcr].

### 4. App Service deploy

Each Azure App Service instance is configured to [listen to a webhook from GitHub, then deploy the image][webhook].
Push the new image:tag to the Azure App Service instance.

[deploy]: https://github.com/cal-itp/benefits/blob/dev/.github/workflows/deploy.yml
[dockerfile]: https://github.com/cal-itp/benefits/blob/dev/Dockerfile
[ghcr]: https://github.com/features/packages
[gh-actions-trigger]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
[webhook]: https://docs.microsoft.com/en-us/azure/app-service/deploy-ci-cd-custom-container

0 comments on commit c67a5b1

Please sign in to comment.