Merge 938e5ca into 586dac3

justin808 · web-flow · commit 7d6eeb7fd514 · 2025-01-29T09:01:01.000Z
diff --git a/.controlplane/controlplane.yml b/.controlplane/controlplane.yml
@@ -39,23 +39,24 @@ aliases:
 
 apps:
   react-webpack-rails-tutorial-production:
-    # Simulate Production Version
+    # Simulate Production Version. Create with this command:
+    # cpflow apply-template app postgres redis daily-task rails -a react-webpack-rails-tutorial-production -o shakacode-open-source-examples-production
     <<: *common
     # Don't allow overriding the org and app by ENV vars b/c production is sensitive!
     allow_org_override_by_env: false
     allow_app_override_by_env: false
 
-    # Use a different organization for production.
-    cpln_org: shakacode-open-source-examples
+    # Use a different organization only for  production.
+    cpln_org: shakacode-open-source-examples-production
 
     upstream: react-webpack-rails-tutorial-staging
 
   react-webpack-rails-tutorial-staging:
     <<: *common
-  # QA Apps are like Heroku review apps, but the use `prefix` so you can run a commmand like
-  # this to create a QA app for the tutorial app.
-  # `cpflow setup gvc postgres redis rails -a qa-react-webpack-rails-tutorial-pr-1234`
   qa-react-webpack-rails-tutorial:
+    # Review Apps are like Heroku review apps, but the use `prefix` so you can run a command like
+    # this to create a QA app for the tutorial app.
+    # `cpflow setup-app -a qa-react-webpack-rails-tutorial-pr-1234`
     <<: *common
     # Order matters!
     setup_app_templates:
diff --git a/.github/actions/validate-required-vars/action.yml b/.github/actions/validate-required-vars/action.yml
@@ -1,6 +1,29 @@
 name: 'Validate Required Variables'
 description: 'Validates that all required secrets and variables for Control Plane operations'
 
+inputs:
+  CPLN_TOKEN_STAGING:
+    required: true
+    description: 'Control Plane Staging Token'
+  CPLN_TOKEN_PRODUCTION:
+    required: true
+    description: 'Control Plane Production Token'
+  CPLN_ORG_STAGING:
+    required: true
+    description: 'Control Plane Staging Organization'
+  CPLN_ORG_PRODUCTION:
+    required: true
+    description: 'Control Plane Production Organization'
+  REVIEW_APP_PREFIX:
+    required: true
+    description: 'Review App Prefix'
+  PRODUCTION_APP_NAME:
+    required: true
+    description: 'Production App Name'
+  STAGING_APP_NAME:
+    required: true
+    description: 'Staging App Name'
+
 runs:
   using: 'composite'
   steps:
@@ -10,19 +33,37 @@ runs:
         missing=()
         
         # Check required secrets
-        if [ -z "$CPLN_TOKEN_STAGING" ]; then
+        if [ -z "${{ inputs.CPLN_TOKEN_STAGING }}" ]; then
           missing+=("Secret: CPLN_TOKEN_STAGING")
         fi
+
+        if [ -z "${{ inputs.CPLN_TOKEN_PRODUCTION }}" ]; then
+          missing+=("Secret: CPLN_TOKEN_PRODUCTION")
+        fi
         
         # Check required variables
-        if [ -z "$CPLN_ORG_STAGING" ]; then
+        if [ -z "${{ inputs.CPLN_ORG_STAGING }}" ]; then
           missing+=("Variable: CPLN_ORG_STAGING")
         fi
-        if [ -z "$REVIEW_APP_PREFIX" ]; then
+
+        if [ -z "${{ inputs.CPLN_ORG_PRODUCTION }}" ]; then
+          missing+=("Variable: CPLN_ORG_PRODUCTION")
+        fi
+
+        if [ -z "${{ inputs.REVIEW_APP_PREFIX }}" ]; then
           missing+=("Variable: REVIEW_APP_PREFIX")
         fi
+
+        if [ -z "${{ inputs.PRODUCTION_APP_NAME }}" ]; then
+          missing+=("Variable: PRODUCTION_APP_NAME")
+        fi
+
+        if [ -z "${{ inputs.STAGING_APP_NAME }}" ]; then
+          missing+=("Variable: STAGING_APP_NAME")
+        fi
         
         if [ ${#missing[@]} -ne 0 ]; then
-          echo "Required secrets/variables are not set: ${missing[*]}"
+          echo "Missing required secrets/variables:"
+          printf '%s\n' "${missing[@]}"
           exit 1
         fi 
diff --git a/.github/workflows/delete-review-app.yml b/.github/workflows/delete-review-app.yml
@@ -44,6 +44,14 @@ jobs:
 
       - name: Validate Required Secrets and Variables
         uses: ./.github/actions/validate-required-vars
+        with:
+          CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}
+          CPLN_TOKEN_PRODUCTION: ${{ secrets.CPLN_TOKEN_PRODUCTION }}
+          CPLN_ORG_STAGING: ${{ vars.CPLN_ORG_STAGING }}
+          CPLN_ORG_PRODUCTION: ${{ vars.CPLN_ORG_PRODUCTION }}
+          REVIEW_APP_PREFIX: ${{ vars.REVIEW_APP_PREFIX }}
+          PRODUCTION_APP_NAME: ${{ vars.PRODUCTION_APP_NAME }}
+          STAGING_APP_NAME: ${{ vars.STAGING_APP_NAME }}
 
       - name: Setup Environment
         uses: ./.github/actions/setup-environment
@@ -108,7 +116,6 @@ jobs:
               issue_number: process.env.PR_NUMBER,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: '🗑️ Starting app deletion...'
               body: [
                 message,
                 '',
@@ -125,10 +132,6 @@ jobs:
           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 }}
-          CPLN_TOKEN: ${{ secrets.CPLN_TOKEN }}
 
       - name: Update Delete Status
         if: always()
@@ -163,3 +166,15 @@ jobs:
               comment_id: ${{ fromJSON(steps.create-delete-comment.outputs.result).commentId }},
               body: success ? successMessage : failureMessage
             });
+
+      - name: Debug Environment
+        run: |
+          echo "Organization: ${{ env.CPLN_ORG }}"
+          echo "App Name: ${{ env.APP_NAME }}"
+          echo "PR Number: ${{ env.PR_NUMBER }}"
+          # Don't echo the actual token, but verify it exists
+          if [ -n "${{ env.CPLN_TOKEN }}" ]; then
+            echo "CPLN_TOKEN is set"
+          else
+            echo "CPLN_TOKEN is empty"
+          fi
diff --git a/.github/workflows/deploy-to-control-plane-review-app.yml b/.github/workflows/deploy-to-control-plane-review-app.yml
@@ -71,6 +71,14 @@ jobs:
 
       - name: Validate Required Secrets and Variables
         uses: ./.github/actions/validate-required-vars
+        with:
+          CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}
+          CPLN_TOKEN_PRODUCTION: ${{ secrets.CPLN_TOKEN_PRODUCTION }}
+          CPLN_ORG_STAGING: ${{ vars.CPLN_ORG_STAGING }}
+          CPLN_ORG_PRODUCTION: ${{ vars.CPLN_ORG_PRODUCTION }}
+          REVIEW_APP_PREFIX: ${{ vars.REVIEW_APP_PREFIX }}
+          PRODUCTION_APP_NAME: ${{ vars.PRODUCTION_APP_NAME }}
+          STAGING_APP_NAME: ${{ vars.STAGING_APP_NAME }}
 
       - name: Get PR HEAD Ref
         id: getRef
@@ -131,9 +139,9 @@ jobs:
             fi
           fi
           
-          # Extract and set PR data
+          # Set PR_NUMBER and override APP_NAME with validated PR number
           echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV
-          echo "APP_NAME=${{ vars.REVIEW_APP_PREFIX }}-$PR_NUMBER" >> $GITHUB_ENV
+          echo "APP_NAME=${{ vars.REVIEW_APP_PREFIX }}-pr-$PR_NUMBER" >> $GITHUB_ENV
           echo "PR_REF=$(echo $PR_DATA | jq -r .headRefName)" >> $GITHUB_OUTPUT
           echo "PR_SHA=$(echo $PR_DATA | jq -r .headRefOid)" >> $GITHUB_ENV
 
@@ -205,7 +213,7 @@ jobs:
           fi
 
       - name: Setup Control Plane App if Not Existing
-        if: env.DO_DEPLOY == 'true' && env.APP_EXISTS == 'false'
+        if: env.DO_DEPLOY != 'false' && env.APP_EXISTS == 'false'
         env:
           CPLN_TOKEN: ${{ secrets.CPLN_TOKEN_STAGING }}
         run: |
@@ -222,7 +230,17 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: process.env.PR_NUMBER,
-              body: '🚀 Starting deployment process...\n\n' + process.env.CONSOLE_LINK
+              body: [
+                `🏗️ Building Docker image for PR [#${process.env.PR_NUMBER}](${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/pull/${process.env.PR_NUMBER}), commit [${context.sha.substring(0, 7)}](${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/commit/${context.sha})`,
+                '',
+                '🚀 Deploying to Control Plane...',
+                '',
+                '⏳ Waiting for deployment to be ready...',
+                '',
+                `📝 [View Build and Deploy Logs](${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}/job/${context.job})`,
+                '',
+                process.env.CONSOLE_LINK
+              ].join('\n')
             });
             core.setOutput('comment-id', result.data.id);
 
@@ -309,25 +327,6 @@ jobs:
           token: ${{ secrets.CPLN_TOKEN_STAGING }}
           org: ${{ vars.CPLN_ORG_STAGING }}
 
-      - name: Update Status - Building
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const buildingMessage = [
-              '🏗️ Building Docker image for PR #${{ needs.process-deployment.outputs.pr_number }}, commit ${{ needs.process-deployment.outputs.pr_sha }}',
-              '',
-              '📝 [View Build Logs](${{ env.WORKFLOW_URL }})',
-              '',
-              process.env.CONSOLE_LINK
-            ].join('\n');
-            
-            await github.rest.issues.updateComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              comment_id: ${{ needs.process-deployment.outputs.comment_id }},
-              body: buildingMessage
-            });
-
       - name: Build Docker Image
         id: build
         uses: ./.github/actions/build-docker-image
@@ -355,22 +354,7 @@ jobs:
         uses: actions/github-script@v7
         with:
           script: |
-            const deployingMessage = [
-              '🚀 Deploying to Control Plane...',
-              '',
-              '⏳ Waiting for deployment to be ready...',
-              '',
-              '📝 [View Deploy Logs](${{ env.WORKFLOW_URL }})',
-              '',
-              process.env.CONSOLE_LINK
-            ].join('\n');
-            
-            await github.rest.issues.updateComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              comment_id: ${{ steps.create-comment.outputs.comment-id }},
-              body: deployingMessage
-            });
+            // Remove this step since we're combining messages
 
       - name: Deploy to Control Plane
         if: env.DO_DEPLOY != 'false'
@@ -415,21 +399,25 @@ jobs:
               '🚀 [Review App for PR #' + prNumber + '](' + appUrl + ')',
               consoleLink,
               '',
-              '📋 [View Completed Action Build and Deploy Logs](' + workflowUrl + ')'
+              '📝 [View Build and Deploy Logs](' + workflowUrl + ')',
+              '',
+              `📋 [View Completed Build and Deploy Logs](${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}/jobs/${context.job.id})`
             ].join('\n');
             
             const failureMessage = [
               '❌ Deployment failed for PR #' + prNumber + ', commit ' + '${{ env.PR_SHA }}',
               '',
               consoleLink,
               '',
-              '📋 [View Deployment Logs with Errors](' + workflowUrl + ')'
+              '📝 [View Build and Deploy Logs](' + workflowUrl + ')',
+              '',
+              `📋 [View Build and Deploy Logs with Errors](${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}/jobs/${context.job.id})`
             ].join('\n');
             
             // Update the existing comment
             await github.rest.issues.updateComment({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              comment_id: ${{ steps.create-comment.outputs.comment-id }},
+              comment_id: ${{ needs.build.outputs.comment_id }},
               body: isSuccess ? successMessage : failureMessage
             });
diff --git a/.github/workflows/help-command.yml b/.github/workflows/help-command.yml
@@ -18,16 +18,16 @@ jobs:
   help:
     if: ${{ (github.event.issue.pull_request && github.event.comment.body == '/help') || github.event_name == 'workflow_dispatch' }}
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Show Available Commands
         uses: actions/github-script@v7
         with:
           script: |
             const sections = {
               commands: {
-                deploy: {
-                  title: '## `/deploy`',
+                "deploy-review-app": {
+                  title: '## `/deploy-review-app`',
                   purpose: '**Purpose:** Deploy a review app for your pull request',
                   details: [
                     '**What it does:**',
@@ -42,8 +42,8 @@ jobs:
                     '  - Example: `/deploy timeout=1800`'
                   ]
                 },
-                destroy: {
-                  title: '## `/destroy`',
+                "delete-review-app: {
+                  title: '## `/delete-review-app`',
                   purpose: '**Purpose:** Remove the review app for your pull request',
                   details: [
                     '**What it does:**',
@@ -96,17 +96,18 @@ jobs:
                 details: [
                   'Review apps are automatically destroyed when:',
                   '1. The pull request is closed',
-                  '2. The `/destroy` command is used',
+                  '2. The `/delete-review-app` command is used',
                   '3. A new deployment is requested (old one is cleaned up first)'
                 ]
               },
               help: {
                 title: '## Need Help?',
                 details: [
-                  'For additional assistance:',
-                  '1. Check the [Control Plane documentation](https://docs.controlplane.com/)',
+                  'For additional assistance, ',
+                  '1. Check the [Control Plane Flow documentation](https://www.shakacode.com/control-plane-flow/docs/)',
                   '2. Contact the infrastructure team',
-                  '3. Open an issue in this repository'
+                  '3. [Open an issue in this repository](https://github.com/shakacode/control-plane-flow/issues/new)',
+                  '4. [Contact ShakaCode support](mailto:justin@shakacode.com)'
                 ]
               }
             };
@@ -148,4 +149,3 @@ jobs:
               issue_number: prNumber,
               body: helpText
             });
-            
diff --git a/.github/workflows/promote-staging-to-production.yml b/.github/workflows/promote-staging-to-production.yml
