Improvements to deployments

.controlplane/Dockerfile

@@ -2,6 +2,10 @@
 ARG RUBY_VERSION=3.3.4
 FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
 
+# Current commit hash environment variable
+ARG GIT_COMMIT
+ENV GIT_COMMIT_SHA=${GIT_COMMIT}
+
 # Install packages needed to build gems and node modules
 RUN apt-get update -qq && \
     apt-get install --no-install-recommends -y build-essential curl git libpq-dev libvips node-gyp pkg-config python-is-python3
@@ -76,7 +80,3 @@ ENTRYPOINT ["./.controlplane/entrypoint.sh"]
 # Default args to pass to the entry point that can be overridden
 # For Kubernetes and ControlPlane, these are the "workload args"
 CMD ["./bin/rails", "server"]
-
-# Current commit hash environment variable
-ARG GIT_COMMIT_SHA
-ENV GIT_COMMIT_SHA=${GIT_COMMIT_SHA}

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

@@ -7,11 +7,9 @@ inputs:
   app_name:
     description: 'The name of the app to deploy'
     required: true
-    default:
   org:
     description: 'The org of the app to deploy'
     required: true
-    default:
 
 runs:
   using: 'composite'
@@ -22,13 +20,14 @@ runs:
     - name: Set Short SHA
       id: vars
       shell: bash
-      run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
+      run: |
+        echo "sha_short=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
 
-    # Caching step
-    - uses: actions/cache@v2
+    # Updated caching step to v3
+    - uses: actions/cache@v3
       with:
         path: /tmp/.docker-cache
-        key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile', '**/package.json', '**/yarn.lock') }}-${{ github.sha   }}
+        key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile', '**/package.json', '**/yarn.lock') }}-${{ github.sha }}
         restore-keys: |
           ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile', '**/package.json', '**/yarn.lock') }}
           ${{ runner.os }}-docker-
@@ -39,6 +38,7 @@ runs:
         if ! cpflow exists -a ${{ inputs.app_name }} ; then
           cpflow setup-app -a ${{ inputs.app_name }}
         fi
+
     # Provision all infrastructure on Control Plane.
     # app react-webpack-rails-tutorial will be created per definition in .controlplane/controlplane.yml
     - name: cpflow build-image
@@ -47,10 +47,10 @@ runs:
         cpln image docker-login
         # Use BUILDKIT_PROGRESS=plain to get more verbose logging of the build
         # BUILDKIT_PROGRESS=plain cpflow build-image -a ${{ inputs.app_name }} --commit ${{steps.vars.outputs.sha_short}} --org ${{inputs.org}}
-        cpflow build-image -a ${{ inputs.app_name }} --commit ${{steps.vars.outputs.sha_short}} --org ${{inputs.org}}
-        # --cache /tmp/.docker-cache
+        cpflow build-image -a ${{ inputs.app_name }} --commit=${{steps.vars.outputs.sha_short}} --org=${{inputs.org}}
+
     - name: Deploy to Control Plane
       shell: bash
       run: |
         echo "Deploying to Control Plane"
-        cpflow deploy-image -a ${{ inputs.app_name }} --run-release-phase --org ${{inputs.org}}  --verbose
+        cpflow deploy-image -a ${{ inputs.app_name }} --run-release-phase --org ${{inputs.org}} --verbose

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

@@ -14,9 +14,9 @@ runs:
     - name: Install Control Plane CLI and cpflow gem
       shell: bash
       run: |
-        sudo npm install -g @controlplane/cli@3.1.0
+        sudo npm install -g @controlplane/cli@3.3.0
         cpln --version
-        gem install cpflow -v 4.0.0
+        gem install cpflow -v 4.1.0
         cpflow --version
 
     - name: cpln profile

.github/workflows/deploy-to-control-plane-review.yml

@@ -1,85 +1,174 @@
-# Control Plane GitHub Action
-
 name: Deploy Review App to Control Plane
 
-# Controls when the workflow will run
 on:
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
-  # Uncomment these lines to trigger the workflow on pull request events
-  # pull_request:
-  #   branches:
-  #     - master
-
-  # deploy on comment "/deploy-review-app"
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches: [master]
   issue_comment:
-    types: [created, edited]
+    types: [created]
+
+concurrency:
+  group: review-app-${{ github.event.pull_request.number || github.event.issue.number }}
+  cancel-in-progress: true
 
-# Convert the GitHub secret variables to environment variables for use by the Control Plane CLI
 env:
   CPLN_ORG: ${{secrets.CPLN_ORG_STAGING}}
   CPLN_TOKEN: ${{secrets.CPLN_TOKEN_STAGING}}
-  # Uncomment this line to use the PR number from the pull requests trigger event (that trigger is commented)
-  # PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
-  PR_NUMBER: ${{ github.event.issue.number }}
+  PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
 
 jobs:
+  check-concurrent:
+    runs-on: ubuntu-latest
+    outputs:
+      cancelled: ${{ steps.check.outputs.cancelled }}
+    steps:
+      - name: Check for concurrent deployment
+        id: check
+        run: |
+          if [ "${{ github.run_attempt }}" != "1" ]; then
+            echo "⚠️ Cancelling previous deployment due to new code push..."
+            echo "cancelled=true" >> $GITHUB_OUTPUT
+          else
+            echo "cancelled=false" >> $GITHUB_OUTPUT
+          fi
+
   deploy-to-control-plane-review:
-    if: ${{ github.event_name != 'issue_comment' || (github.event.comment.body == '/deploy-review-app' && github.event.issue.pull_request) }}
+    needs: check-concurrent
+    if: |
+      needs.check-concurrent.outputs.cancelled != 'true' &&
+      (github.event_name == 'workflow_dispatch' ||
+       github.event_name == 'pull_request' ||
+       (github.event_name == 'issue_comment' && 
+        github.event.comment.body == '/deploy-review-app' && 
+        github.event.issue.pull_request))
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+      deployments: write
+      pull-requests: write
+
+    outputs:
+      app_url: ${{ steps.deploy.outputs.app_url }}
+      deployment_id: ${{ steps.create-deployment.outputs.result.deployment_id }}
+
     steps:
+      - name: Notify deployment start
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const message = `🚀 Starting new deployment for commit: ${context.sha.substring(0, 7)}
+            ${context.payload.commits ? `\nChanges: ${context.payload.commits[0].message}` : ''}`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number || context.payload.pull_request.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: message
+            });
+
+      - name: Create GitHub Deployment
+        id: create-deployment
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const deployment = await github.rest.repos.createDeployment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: context.sha,
+              environment: 'review-app',
+              auto_merge: false,
+              required_contexts: []
+            });
+            return { deployment_id: deployment.data.id };
+
       - name: Get PR HEAD Ref
         if: ${{ github.event_name == 'issue_comment' }}
         id: getRef
-        run: echo "PR_REF=$(gh pr view $PR_NUMBER --repo ${{ github.repository }} --json headRefName | jq -r '.headRefName')" >> $GITHUB_OUTPUT
+        run: |
+          echo "PR_REF=$(gh pr view $PR_NUMBER --repo ${{ github.repository }} --json headRefName | jq -r '.headRefName')" >> $GITHUB_OUTPUT
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Checkout source code from Github
+      - name: Checkout source code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ steps.getRef.outputs.PR_REF || github.ref }}
 
-      - name: Add GitHub Comment
-        if: ${{ github.event_name == 'issue_comment' }}
+      - name: Update deployment status (in_progress)
         uses: actions/github-script@v7
         with:
           script: |
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
+            await github.rest.repos.createDeploymentStatus({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: "We started working on your review-app deployment. You can track progress in the `Actions` Tab [here](https://github.com/shakacode/react-webpack-rails-tutorial/actions/workflows/deploy-to-control-plane-review.yml) on Github."
-            })
+              deployment_id: ${{ steps.create-deployment.outputs.result.deployment_id }},
+              state: 'in_progress',
+              description: 'Deployment is in progress'
+            });
 
-      - name: Get PR number
-        if: ${{ github.event_name != 'issue_comment' }}
-        run: |
-          echo "GITHUB_REPOSITORY: \"$GITHUB_REPOSITORY\""
-          if [ -z "$PR_NUMBER" ]; then
-            echo "PR_NUMBER is not in the trigger event. Fetching PR number from open PRs."
-            REF="${{ github.ref }}"
-            REF=${REF#refs/heads/}  # Remove 'refs/heads/' prefix
-            echo "REF: \"$REF\""
-            API_RESPONSE=$(curl --location --request GET "https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls?state=open" \
-            --header 'Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}')
-            PR_NUMBER=$(echo "$API_RESPONSE" | jq '.[] | select(.head.ref=="'$REF'") | .number')
-          fi
-          echo "PR_NUMBER: $PR_NUMBER"
-          if [ -z "$PR_NUMBER" ]; then
-            echo "PR_NUMBER is not set. Aborting."
-            exit 1
-          fi
-          echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV
-      - name: Get App Name
+      - name: Configure app name
+        id: app-config
         run: |
-          echo "PR_NUMBER: ${{ env.PR_NUMBER }}"
-          echo "APP_NAME=qa-react-webpack-rails-tutorial-pr-${{ env.PR_NUMBER }}" >> "$GITHUB_ENV"
-          echo "App Name: ${{ env.APP_NAME }}"
-      - uses: ./.github/actions/deploy-to-control-plane
+          APP_NAME="qa-react-webpack-rails-tutorial-pr-${{ env.PR_NUMBER }}"
+          echo "APP_NAME=$APP_NAME" >> $GITHUB_ENV
+          echo "app_name=$APP_NAME" >> $GITHUB_OUTPUT
+
+      - name: Deploy to Control Plane
+        id: deploy
+        uses: ./.github/actions/deploy-to-control-plane
         with:
           app_name: ${{ env.APP_NAME }}
           org: ${{ env.CPLN_ORG }}
+
+      - name: Update deployment status (success)
+        if: success()
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const message = `✅ Deployment successful!
+            Environment: review-app
+            Commit: ${context.sha.substring(0, 7)}
+            URL: ${{ steps.deploy.outputs.app_url }}`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number || context.payload.pull_request.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: message
+            });
+
+            await github.rest.repos.createDeploymentStatus({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              deployment_id: ${{ steps.create-deployment.outputs.result.deployment_id }},
+              state: 'success',
+              environment_url: '${{ steps.deploy.outputs.app_url }}',
+              description: 'Deployment successful'
+            });
+
+      - name: Update deployment status (failure)
+        if: failure()
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const message = `❌ Deployment failed
+            Commit: ${context.sha.substring(0, 7)}
+            Please check the [workflow logs](${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}) for details.`;
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number || context.payload.pull_request.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: message
+            });
+
+            await github.rest.repos.createDeploymentStatus({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              deployment_id: ${{ steps.create-deployment.outputs.result.deployment_id }},
+              state: 'failure',
+              description: 'Deployment failed'
+            });