Post-Deployment Health Check #4377
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Post-Deployment Health Check | |
| on: | |
| workflow_run: | |
| workflows: | |
| - "Build and deploy" | |
| - "Build and deploy testing" | |
| types: | |
| - completed | |
| workflow_dispatch: | |
| inputs: | |
| target_url: | |
| description: 'Target URL to health check' | |
| required: true | |
| type: choice | |
| options: | |
| - https://www.pulumi.com | |
| - https://www.pulumi-test.io | |
| default: 'https://www.pulumi.com' | |
| environment: | |
| description: 'Environment name (for Slack notifications)' | |
| required: true | |
| type: choice | |
| options: | |
| - production | |
| - testing | |
| default: 'production' | |
| permissions: | |
| contents: read | |
| env: | |
| ESC_ACTION_OIDC_AUTH: true | |
| ESC_ACTION_OIDC_ORGANIZATION: pulumi | |
| ESC_ACTION_OIDC_REQUESTED_TOKEN_TYPE: urn:pulumi:token-type:access_token:organization | |
| ESC_ACTION_ENVIRONMENT: github-secrets/pulumi-docs | |
| ESC_ACTION_EXPORT_ENVIRONMENT_VARIABLES: false | |
| jobs: | |
| health-check: | |
| name: Run post-deployment health checks | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }} | |
| outputs: | |
| url: ${{ steps.target.outputs.url }} | |
| environment: ${{ steps.target.outputs.environment }} | |
| slack_channel: ${{ steps.target.outputs.slack_channel }} | |
| steps: | |
| - name: Determine target environment | |
| id: target | |
| run: | | |
| if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then | |
| echo "url=${{ inputs.target_url }}" >> $GITHUB_OUTPUT | |
| echo "environment=${{ inputs.environment }}" >> $GITHUB_OUTPUT | |
| if [[ "${{ inputs.environment }}" == "production" ]]; then | |
| echo "slack_channel=docs-ops" >> $GITHUB_OUTPUT | |
| else | |
| echo "slack_channel=docs-ops-test" >> $GITHUB_OUTPUT | |
| fi | |
| elif [[ "${{ github.event.workflow_run.name }}" == "Build and deploy" ]]; then | |
| echo "url=https://www.pulumi.com" >> $GITHUB_OUTPUT | |
| echo "environment=production" >> $GITHUB_OUTPUT | |
| echo "slack_channel=docs-ops" >> $GITHUB_OUTPUT | |
| else | |
| echo "url=https://www.pulumi-test.io" >> $GITHUB_OUTPUT | |
| echo "environment=testing" >> $GITHUB_OUTPUT | |
| echo "slack_channel=docs-ops-test" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Run health checks | |
| run: | | |
| #!/bin/bash | |
| set -e | |
| BASE_URL="${{ steps.target.outputs.url }}" | |
| FAILED=0 | |
| echo "🏥 Post-Deployment Health Check" | |
| echo "Target: $BASE_URL" | |
| echo "" | |
| # Function to check endpoint returns 200 | |
| check_endpoint() { | |
| local path="$1" | |
| local name="$2" | |
| local url="${BASE_URL}${path}" | |
| status=$(curl -s -o /dev/null -w "%{http_code}" -L "$url") | |
| if [[ "$status" == "200" ]]; then | |
| echo "✅ $name: $status" | |
| else | |
| echo "❌ $name: Expected 200, got $status" | |
| FAILED=1 | |
| fi | |
| } | |
| # Function to check redirect | |
| check_redirect() { | |
| local path="$1" | |
| local expected_location="$2" | |
| local name="$3" | |
| local url="${BASE_URL}${path}" | |
| # Get status and location without following redirects | |
| response=$(curl -s -o /dev/null -w "%{http_code}|%{redirect_url}" "$url") | |
| status="${response%%|*}" | |
| location="${response##*|}" | |
| if [[ "$status" == "301" ]] && [[ "$location" =~ $expected_location ]]; then | |
| echo "✅ $name: $status → $location" | |
| else | |
| echo "❌ $name: Expected 301 to match '$expected_location', got $status → $location" | |
| FAILED=1 | |
| fi | |
| } | |
| echo "Testing endpoints..." | |
| check_endpoint "/" "Homepage" | |
| check_endpoint "/docs" "Docs landing" | |
| check_endpoint "/registry" "Registry landing" | |
| check_endpoint "/docs/reference/pkg/nodejs/pulumi/pulumi/" "Node.js SDK" | |
| check_endpoint "/docs/reference/pkg/python/pulumi/" "Python SDK" | |
| check_endpoint "/docs/reference/pkg/dotnet/pulumi/pulumi.html" ".NET SDK" | |
| check_endpoint "/docs/reference/pkg/java/" "Java SDK" | |
| check_endpoint "/docs/iac/get-started/" "Getting started" | |
| check_endpoint "/docs/cli/commands/" "CLI reference" | |
| echo "" | |
| echo "Testing Lambda@Edge redirects..." | |
| check_redirect "/docs/intro/cloud-providers/aws/" "/registry/packages/aws/" "Cloud provider redirect" | |
| check_redirect "/docs/reference/pkg/nodejs/pulumi/aws/" "/docs/reference/pkg/aws/\\?language=nodejs" "Node.js SDK redirect" | |
| echo "" | |
| echo "==================================================" | |
| if [[ $FAILED -eq 0 ]]; then | |
| echo "✅ All health checks passed!" | |
| exit 0 | |
| else | |
| echo "❌ Some health checks failed!" | |
| exit 1 | |
| fi | |
| notify: | |
| name: Send Slack notification on failure | |
| runs-on: ubuntu-latest | |
| needs: [health-check] | |
| if: failure() | |
| steps: | |
| - name: Fetch secrets from ESC | |
| id: esc-secrets | |
| uses: pulumi/esc-action@v3 | |
| - name: Send Slack notification | |
| uses: docker://sholung/action-slack-notify:v2.3.0 | |
| env: | |
| SLACK_CHANNEL: ${{ needs.health-check.outputs.slack_channel || 'docs-ops' }} | |
| SLACK_COLOR: "#F54242" | |
| SLACK_MESSAGE: | | |
| 🚨 Post-deployment health check failed for ${{ needs.health-check.outputs.environment || 'production' }} | |
| Workflow: ${{ github.event.workflow_run.html_url }} | |
| Deployment: ${{ github.event.workflow_run.name }} | |
| Commit: ${{ github.event.workflow_run.head_sha }} | |
| Check the workflow logs for details: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} | |
| SLACK_USERNAME: docsbot | |
| SLACK_WEBHOOK: ${{ steps.esc-secrets.outputs.SLACK_WEBHOOK_URL }} | |
| SLACK_ICON: https://www.pulumi.com/logos/brand/avatar-on-white.png |