Update docs and remove unused workflow

atlosdotorg · Aug 26, 2024 · bd40ee0 · bd40ee0
1 parent 4fcafc9
commit bd40ee0
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 21 deletions.
diff --git a/.github/workflows/deploy-gap.yml b/.github/workflows/deploy-gap.yml
diff --git a/platform/deployments/README.md b/platform/deployments/README.md
@@ -26,7 +26,7 @@ To setup continuous deployment, you'll need to configure a GitHub environment wi
 
 * `AZURE_CREDENTIALS`: The output of `az ad sp create-for-rbac --name "github-actions-<staging/prod>" --role contributor --scopes /subscriptions/<subscription_id>/resourceGroups/<resource_group_id> --json-auth`
   * Note (+ TODO): This credential is _overprovisioned_. Azure shockingly doesn't have a built-in role for "deploy to Azure Container Apps", so we have to use the `contributor` role. This is a security risk, but it's the best we can do for now without getting Azure P2 or P3. They [say](https://github.com/microsoft/azure-container-apps/issues/35#issuecomment-1675072081) that they will introduce more roles in Q4 2023.
-* `AZURE_CONTAINER_APP_NAME`: The name of the Azure Container App name
+* `AZURE_CONTAINER_APP_NAME`: The name of the Azure Container App (e.g., `ca-main-platform-staging-eastus`)
 * `AZURE_CONTAINER_APP_RESOURCE_GROUP`: The name of the Azure Container Apps resource group
 
 You'll also need to be sure that a corresponding GitHub Actions workflow file exists for the given deployment.