Skip to content

Commit

Permalink
fix deploy falsely reports passing when it failed
Browse files Browse the repository at this point in the history
Several issues were identified with the workflow:
* If the webapp publish profile secret is empty, webapps-deploy v3 doesn’t deploy but reports the deploy as passing.  See Azure/webapps-deploy [Issue #404](Azure/webapps-deploy#404).
* Configs were set before running the deploy.  This means that the config values in Azure are updated even if the deploy fails.
* As written, the action was runnable by anyone with write access.  That is too broad for production.

To avoid these known issues:
* check that all required secrets are set before proceeding
* call the reusable workflow that checks if the user has access to deploy

_NOTE: Configs cannot be moved after the deploy because they are used by the restart process kicked of by the deploy._
  • Loading branch information
elrayle committed Apr 12, 2024
1 parent 8214149 commit 28e174a
Showing 1 changed file with 56 additions and 7 deletions.
63 changes: 56 additions & 7 deletions .github/workflows/build_and_deploy_prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ on:
# There are secrets and environment variables that need to be set that control what is pushed to
# ghcr and Azure.
#
# Org Secrets:
# AZURE_CREDENTIALS: service principal that has access to the Azure apps
#
# Secrets:
# AZURE_CREDENTIALS_PROD: service principal that has access to the Azure prod WebApp
# AZURE_WEBAPP_PUBLISH_PROFILE: publish profile for the Azure WebApp
# AZURE_WEBAPP_PUBLISH_PROFILE_EU: publish profile for the Azure WebApp in Europe
# AZURE_WEBAPP_PUBLISH_PROFILE: publish profile for the service production Azure WebApp
# AZURE_WEBAPP_PUBLISH_PROFILE_EU: publish profile for the service production Azure WebApp in Europe
#
# Environment Variables:
# APPLICATION_TYPE: type of application that is being deployed; used to add a label to the Docker image (values: api | web | worker)
Expand All @@ -34,9 +36,51 @@ env:
DOCKER_IMAGE_NAME: ghcr.io/${{ github.repository_owner }}/${{ github.repository }}

jobs:
check-deployable:
uses: clearlydefined/operations/.github/workflows/deployable.yml@elr/deploy-limits
secrets: inherit

verify-secrets:
name: Secrets Verification
runs-on: ubuntu-latest
steps:
- name: Check secrets
run: |
missing=false
secret_value=$(echo '${{ secrets.AZURE_CREDENTIALS }}')
single_line_value=$(echo -n "$secret_value" | tr -d '\n')
len=${#single_line_value}
if [[ ${len} -le 0 ]]; then
echo "Secret AZURE_CREDENTIALS does not have a value"
missing=true
fi
secret_value=$(echo '${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE_PROD }}')
single_line_value=$(echo -n "$secret_value" | tr -d '\n')
len=${#single_line_value}
if [[ ${len} -le 0 ]]; then
echo "Secret AZURE_WEBAPP_PUBLISH_PROFILE_PROD does not have a value"
missing=true
fi
secret_value=$(echo '${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE_PROD_EU }}')
single_line_value=$(echo -n "$secret_value" | tr -d '\n')
len=${#single_line_value}
if [[ ${len} -le 0 ]]; then
echo "Secret AZURE_WEBAPP_PUBLISH_PROFILE_PROD_EU does not have a value"
missing=true
fi
if [[ $missing == true ]]; then
exit 1
fi
echo "Required secrets all have values"
build-and-deploy:
name: Build and Deploy
runs-on: ubuntu-latest
needs: [ check-deployable, verify-secrets ]
steps:
- name: Get version
id: package
Expand Down Expand Up @@ -75,7 +119,7 @@ jobs:
- name: Login for Azure cli commands
uses: azure/[email protected]
with:
creds: ${{ secrets.AZURE_CREDENTIALS_PROD }}
creds: ${{ secrets.AZURE_CREDENTIALS }}

- name: Set DOCKER configs in Azure web app
uses: azure/[email protected]
Expand Down Expand Up @@ -104,9 +148,11 @@ jobs:
"slotSetting": false
}
]
# v3.0.1 passes when AZURE_WEBAPP_PUBLISH_PROFILE_PROD isn't set, but should fail.
# Added secret check above to ensure it is set.
- name: Deploy to Azure WebApp
uses: azure/[email protected].0
uses: azure/[email protected].1
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE_PROD }}
Expand Down Expand Up @@ -140,9 +186,12 @@ jobs:
}
]
# v3.0.1 passes when AZURE_WEBAPP_PUBLISH_PROFILE_PROD_EU isn't set, but should fail.
# Added secret check to ensure it is set.
- name: Deploy to Azure EU WebApp
uses: azure/[email protected].0
uses: azure/[email protected].1
with:
app-name: ${{ env.AZURE_EU_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE_PROD_EU }}
images: '${{ env.DOCKER_IMAGE_NAME }}:${{ steps.package.outputs.version }}'

0 comments on commit 28e174a

Please sign in to comment.