Add comments to the workflow skip stuff

CDCgov · Mar 7, 2023 · bc62f09 · bc62f09
1 parent dd32a68
commit bc62f09
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/.github/workflows/deploy_reusable-skip.yml b/.github/workflows/deploy_reusable-skip.yml
@@ -1,3 +1,6 @@
+# Used when a PR doesn't have any changes that require the PR deploy.
+# The jobs' keys/names must align with the `deploy_reusable.yml` jobs' keys/names.
+
 name: 'Container Build & Deploy'
 
 on:

diff --git a/.github/workflows/terraform-ci-deploy.yml b/.github/workflows/terraform-ci-deploy.yml
@@ -40,12 +40,13 @@ jobs:
       AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
 
 
-  terraform-deploy-skip:
+  terraform-deploy-skip:  # runs when the PR doesn't have any changes that require the PR deploy; this ensures we get the appropriate required PR checks
     name: PR Infrastructure Deploy
     needs: paths-filter
     uses: ./.github/workflows/terraform-deploy_reusable-skip.yml
     if: needs.paths-filter.outputs.operations != 'true'
 
+
   pr-deploy:
     name: PR Application Deploy
     needs:
@@ -65,13 +66,15 @@ jobs:
       AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
       AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
 
-  pr-deploy-skip:
+
+  pr-deploy-skip:  # runs when the PR doesn't have any changes that require the PR deploy; this ensures we get the appropriate required PR checks
     name: PR Application Deploy
     needs:
       - paths-filter
     uses: ./.github/workflows/deploy_reusable-skip.yml
     if: needs.paths-filter.outputs.operations != 'true'
 
+
   destroy-environment:
     name: Destroy PR Environment
     needs:

diff --git a/.github/workflows/terraform-deploy_reusable-skip.yml b/.github/workflows/terraform-deploy_reusable-skip.yml
@@ -1,3 +1,6 @@
+# Used when a PR doesn't have any changes that require the PR deploy.
+# The job's keys/names must align with the `terraform-deploy_reusable.yml` job's keys/names.
+
 name: Terraform Deploy
 
 on: