brought in changes from master

Author: justin808

.github/actions/deploy-to-control-plane/action.yml

@@ -16,7 +16,7 @@ inputs:
   wait_timeout:
     description: 'Timeout in seconds for waiting for workloads to be ready'
     required: false
-    default: 600
+    default: '900'
 
 outputs:
   review_app_url:
@@ -26,6 +26,21 @@ outputs:
 runs:
   using: "composite"
   steps:
+    - name: Validate Required Secrets
+      shell: bash
+      run: |
+        missing_secrets=()
+        for secret in "CPLN_TOKEN" "CPLN_ORG"; do
+          if [ -z "${!secret}" ]; then
+            missing_secrets+=("$secret")
+          fi
+        done
+        
+        if [ ${#missing_secrets[@]} -ne 0 ]; then
+          echo "Required secrets are not set: ${missing_secrets[*]}"
+          exit 1
+        fi
+
     - name: Setup Environment
       uses: ./.github/actions/setup-environment
 

.github/actions/deploy-to-control-plane/scripts/deploy.sh

@@ -1,11 +1,15 @@
 #!/bin/bash
 
 # This script handles the deployment to Control Plane and extracts the Rails URL
-# 
+#
 # Required environment variables:
 # - APP_NAME: Name of the application to deploy
 # - CPLN_ORG: Control Plane organization
 #
+# Optional environment variables:
+# - WAIT_TIMEOUT: Timeout in seconds for deployment (default: 900)
+#                 Must be a positive integer
+#
 # Outputs:
 # - rails_url: URL of the deployed Rails application
 
@@ -15,29 +19,48 @@ set -e
 : "${APP_NAME:?APP_NAME environment variable is required}"
 : "${CPLN_ORG:?CPLN_ORG environment variable is required}"
 
-# Set deployment timeout (15 minutes)
-TIMEOUT=900
+# Set and validate deployment timeout
+WAIT_TIMEOUT=${WAIT_TIMEOUT:-900}
+if ! [[ "${WAIT_TIMEOUT}" =~ ^[0-9]+$ ]]; then
+  echo "❌ Invalid timeout value: ${WAIT_TIMEOUT}"
+  exit 1
+fi
 
 TEMP_OUTPUT=$(mktemp)
 trap 'rm -f "$TEMP_OUTPUT"' EXIT
 
 # Deploy the application
-echo "🚀 Deploying to Control Plane..."
-if timeout "$TIMEOUT" cpflow deploy-image -a "$APP_NAME" --run-release-phase --org "$CPLN_ORG" --verbose | tee "$TEMP_OUTPUT"; then
-    # Extract Rails URL from deployment output
-    RAILS_URL=$(grep -oP 'https://rails-[^[:space:]]*\.cpln\.app(?=\s|$)' "$TEMP_OUTPUT" | head -n1)
-    if [ -n "$RAILS_URL" ]; then
-        echo "rails_url=$RAILS_URL" >> "$GITHUB_OUTPUT"
-        echo "✅ Deployment successful"
-        echo "🚀 Rails URL: $RAILS_URL"
-    else
-        echo "❌ Failed to extract Rails URL from deployment output"
-        exit 1
-    fi
-elif [ $? -eq 124 ]; then
-    echo "❌ Deployment timed out after $TIMEOUT seconds"
-    exit 1
-else
-    echo "❌ Deployment to Control Plane failed"
-    exit 1
+echo "🚀 Deploying to Control Plane (timeout: ${WAIT_TIMEOUT}s)"
+if ! timeout "${WAIT_TIMEOUT}" cpflow deploy-image -a "$APP_NAME" --run-release-phase --org "$CPLN_ORG" --verbose 2>&1 | tee "$TEMP_OUTPUT"; then
+  echo "❌ Deployment failed"
+  echo "Full output:"
+  cat "$TEMP_OUTPUT"
+  exit 1
+fi
+
+# Extract app URL from deployment output
+RAILS_URL=$(grep -oP 'https://rails-[^[:space:]]*\.cpln\.app(?=\s|$)' "$TEMP_OUTPUT" | head -n1)
+if [ -z "$RAILS_URL" ]; then
+  echo "❌ Failed to get app URL from deployment output"
+  echo "Full output:"
+  cat "$TEMP_OUTPUT"
+  exit 1
+fi
+
+# Wait for all workloads to be ready
+echo "⏳ Waiting for all workloads to be ready (timeout: ${WAIT_TIMEOUT}s)"
+if ! timeout "${WAIT_TIMEOUT}" bash -c "cpflow ps:wait -a \"$APP_NAME\"" 2>&1 | tee -a "$TEMP_OUTPUT"; then
+  TIMEOUT_EXIT=$?
+  if [ ${TIMEOUT_EXIT} -eq 124 ]; then
+    echo "❌ Timed out waiting for workloads after ${WAIT_TIMEOUT} seconds"
+  else
+    echo "❌ Workloads did not become ready"
+  fi
+  echo "Full output:"
+  cat "$TEMP_OUTPUT"
+  exit 1
 fi
+
+echo "✅ Deployment successful"
+echo "🌐 Rails URL: $RAILS_URL"
+echo "rails_url=$RAILS_URL" >> "$GITHUB_OUTPUT"

.github/actions/setup-environment/action.yml

@@ -3,6 +3,14 @@
 name: 'Setup Environment'
 description: 'Sets up Ruby, installs Control Plane CLI, cpflow gem, and sets up the default profile'
 
+inputs:
+  token:
+    description: 'Control Plane token'
+    required: true
+  org:
+    description: 'Control Plane organization'
+    required: true
+
 runs:
   using: 'composite'
   steps:
@@ -22,19 +30,22 @@ runs:
     - name: Setup Control Plane Profile
       shell: bash
       run: |
-        if [ -z "$CPLN_TOKEN" ]; then
-          echo " Error: CPLN_TOKEN environment variable is not set"
+        TOKEN="${{ inputs.token }}"
+        ORG="${{ inputs.org }}"
+        
+        if [ -z "$TOKEN" ]; then
+          echo " Error: Control Plane token not provided"
           exit 1
         fi
         
-        if [ -z "$CPLN_ORG" ]; then
-          echo " Error: CPLN_ORG environment variable is not set"
+        if [ -z "$ORG" ]; then
+          echo " Error: Control Plane organization not provided"
           exit 1
         fi
         
         echo "Setting up Control Plane profile..."
-        echo "Organization: $CPLN_ORG"
-        cpln profile update default --org "$CPLN_ORG" --token "$CPLN_TOKEN"
+        echo "Organization: $ORG"
+        cpln profile update default --org "$ORG" --token "$TOKEN"
         
         echo "Setting up Docker login for Control Plane registry..."
-        cpln image docker-login --org "$CPLN_ORG"
+        cpln image docker-login --org "$ORG"

.github/workflows/add-comment-on-pr-creation.yml

@@ -1,20 +1,30 @@
-name: Add helper Comment on PR creation
+name: Add Comment on PR Creation
 
 on:
   pull_request:
     types: [opened]
 
 jobs:
-  comment-on-pr:
+  add-comment:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
     steps:
-      - name: Add GitHub Comment for review app instructions
-        uses: actions/github-script@v7
-        with:
-          script: |
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: "Hi 👋 To deploy a review app, please comment `/deploy-review-app`"
-            })
+    - uses: actions/github-script@v7
+      name: Add GitHub Comment for review app instructions
+      with:
+        script: |
+          await github.rest.issues.createComment({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: context.payload.pull_request.number,
+            body: [
+              "Hi 👋 Here are the commands available for this PR:",
+              "",
+              "- `/deploy-review-app`: Deploy your changes to a review environment",
+              "- `/delete-review-app`: Clean up the review environment when you're done",
+              "- `/help`: Show detailed information about all commands",
+              "",
+              "Use `/help` to see full documentation, including configuration options."
+            ].join("\n")
+          });

.github/workflows/delete-review-app.yml

@@ -1,6 +1,8 @@
 name: Delete Review App
 
 on:
+  pull_request:
+    types: [closed]
   issue_comment:
     types: [created]
 
@@ -12,14 +14,18 @@ permissions:
 
 env:
   CPLN_ORG: ${{ secrets.CPLN_ORG_STAGING }}
-  CPLN_TOKEN: ${{ secrets.CPLN_TOKEN_STAGING }}
+  CPLN_TOKEN: ${{ secrets.CPLN_TOKEN }}
+  APP_NAME: qa-react-webpack-rails-tutorial-pr-${{ github.event.pull_request.number || github.event.issue.number }}
+  PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
 
 jobs:
   Process-Delete-Command:
     if: |
-      github.event_name == 'issue_comment' && 
-      github.event.issue.pull_request && 
-      github.event.comment.body == '/delete-review-app'
+      (github.event_name == 'issue_comment' && 
+       github.event.issue.pull_request && 
+       github.event.comment.body == '/delete-review-app') ||
+      (github.event_name == 'pull_request' && 
+       github.event.action == 'closed')
     runs-on: ubuntu-latest
 
     steps:
@@ -37,24 +43,97 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      - name: Validate Required Secrets
+        run: |
+          missing_secrets=()
+          for secret in "CPLN_TOKEN" "CPLN_ORG"; do
+            if [ -z "${!secret}" ]; then
+              missing_secrets+=("$secret")
+            fi
+          done
+          
+          if [ ${#missing_secrets[@]} -ne 0 ]; then
+            echo "Required secrets are not set: ${missing_secrets[*]}"
+            exit 1
+          fi
+
       - name: Setup Environment
         uses: ./.github/actions/setup-environment
 
+      - name: Set shared functions
+        id: shared-functions
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.exportVariable('GET_CONSOLE_LINK', `
+              function getConsoleLink(prNumber) {
+                return '🎮 [Control Plane Console](' + 
+                       'https://console.cpln.io/console/org/' + process.env.CPLN_ORG + '/gvc/' + process.env.APP_NAME + '/-info)';
+              }
+            `);
+
+      - name: Setup Workflow URL
+        id: setup-workflow-url
+        uses: actions/github-script@v7
+        with:
+          script: |
+            async function getWorkflowUrl(runId) {
+              // Get the current job ID
+              const jobs = await github.rest.actions.listJobsForWorkflowRun({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                run_id: runId
+              });
+              
+              const currentJob = jobs.data.jobs.find(job => job.status === 'in_progress');
+              const jobId = currentJob?.id;
+              
+              if (!jobId) {
+                console.log('Warning: Could not find current job ID');
+                return `${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${runId}`;
+              }
+              
+              return `${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${runId}/job/${jobId}`;
+            }
+            
+            const workflowUrl = await getWorkflowUrl(context.runId);
+            core.exportVariable('WORKFLOW_URL', workflowUrl);
+            return { workflowUrl };
+
       - name: Create Initial Delete Comment
-        id: init-delete
+        id: create-delete-comment
         uses: actions/github-script@v7
         with:
           script: |
+            eval(process.env.GET_CONSOLE_LINK);
+            
+            let message = '🗑️ Starting app deletion';
+            if ('${{ github.event_name }}' === 'pull_request') {
+              const merged = '${{ github.event.pull_request.merged }}' === 'true';
+              message += merged ? ' (PR merged)' : ' (PR closed)';
+            }
+            
             const comment = await github.rest.issues.createComment({
               issue_number: process.env.PR_NUMBER,
               owner: context.repo.owner,
               repo: context.repo.repo,
               body: '🗑️ Starting app deletion...'
+              body: [
+                message,
+                '',
+                ' 🗑️ [View Delete Logs](' + process.env.WORKFLOW_URL + ')',
+                '',
+                getConsoleLink(process.env.PR_NUMBER)
+              ].join('\n')
             });
             return { commentId: comment.data.id };
 
       - name: Delete Review App
         uses: ./.github/actions/delete-control-plane-app
+        with:
+          app_name: ${{ env.APP_NAME }}
+          org: ${{ env.CPLN_ORG }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
         env:
           APP_NAME: ${{ env.APP_NAME }}
           CPLN_ORG: ${{ secrets.CPLN_ORG }}
@@ -65,21 +144,31 @@ jobs:
         uses: actions/github-script@v7
         with:
           script: |
+            eval(process.env.GET_CONSOLE_LINK);
+            
             const success = '${{ job.status }}' === 'success';
             const prNumber = process.env.PR_NUMBER;
             const cpConsoleUrl = `https://console.cpln.io/org/${process.env.CPLN_ORG}/workloads/${process.env.APP_NAME}`;
             
-            const message = success
-              ? '✅ Review app for PR #' + prNumber + ' was successfully deleted'
-              : [
-                  '❌ Review app for PR #' + prNumber + ' failed to be deleted',
-                  '',
-                  '[View in Control Plane Console](' + cpConsoleUrl + ')'
-                ].join('\n');
+            const successMessage = [
+              '✅ Review app for PR #' + prNumber + ' was successfully deleted',
+              '',
+              ' [View Completed Delete Logs](' + process.env.WORKFLOW_URL + ')',
+              '',
+              ' [Control Plane Organization](https://console.cpln.io/console/org/' + process.env.CPLN_ORG + '/-info)'
+            ].join('\n');
+            
+            const failureMessage = [
+              '❌ Review app for PR #' + prNumber + ' failed to be deleted',
+              '',
+              ' [View Delete Logs with Errors](' + process.env.WORKFLOW_URL + ')',
+              '',
+              getConsoleLink(prNumber)
+            ].join('\n');
             
             await github.rest.issues.updateComment({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              comment_id: ${{ fromJSON(steps.init-delete.outputs.result).commentId }},
-              body: message
+              comment_id: ${{ fromJSON(steps.create-delete-comment.outputs.result).commentId }},
+              body: success ? successMessage : failureMessage
             });