add initial action to create preview environments from PR builds (#4)

Author: whummer

action.yml

@@ -31,6 +31,10 @@ inputs:
     description: 'Github token used to create PR comments'
     required: false
     default: ''
+  preview-cmd:
+    description: 'Command(s) used to create a preview of the PR (can use $AWS_ENDPOINT_URL)'
+    required: false
+    default: ''
 
 runs:
   using: "composite"
@@ -70,3 +74,8 @@ runs:
         INSTALL_AWSLOCAL: "${{ inputs.install-awslocal }}"
         USE_PRO: "${{ inputs.use-pro }}"
         CONFIGURATION: "${{ inputs.configuration }}"
+
+    # TODO: potentially add an additional step here to create preview envs, and add a switch to
+    #       enable/disable the "Start LocalStack" action above. This way we could make this action
+    #       the single entry point which then delegates to sub-actions in this repo, based on the
+    #       user-provided configuration...

finish/action.yml

@@ -5,8 +5,12 @@ inputs:
     description: 'Github token used to create PR comments'
     required: true
   ci-project:
-    description: 'Name of the CI project to track in LocalStack Cloud'
-    required: true
+    description: 'Name of the CI project tracked in LocalStack Cloud'
+    required: false
+  include-preview:
+    description: 'Whether to include the created preview URL in the PR comment'
+    type: boolean
+    default: false
 
 runs:
   using: composite
@@ -22,12 +26,23 @@ runs:
       shell: bash
       run: echo "pr_id=$(<pr-id.txt)" >> $GITHUB_OUTPUT
 
+    - name: Load the preview URL
+      shell: bash
+      if: inputs.include-preview
+      run: |
+        if [[ -e ls-preview-url.txt ]]; then
+          echo "LS_PREVIEW_URL=$(<ls-preview-url.txt)" >> $GITHUB_ENV
+        else
+          echo "LS_PREVIEW_URL=Unable to determine preview URL" >> $GITHUB_ENV
+        fi
+
     - name: Update status comment
       uses: actions-cool/maintain-one-comment@v3.1.1
       with:
         token: ${{ inputs.github-token }}
         body: |
-          🚀 LocalStack Stack Insights and Cloud Pod state for this CI run: https://app.localstack.cloud/ci/${{ inputs.ci-project }}
+          ${{ inputs.ci-project && format('{0}{1}', '🚀 LocalStack Stack Insights and Cloud Pod state for this CI run: https://app.localstack.cloud/ci/', inputs.ci-project) }}
+          ${{ inputs.include-preview && format('{0}{1}', '🚀 Preview for this PR: ', env.LS_PREVIEW_URL) }}
           <!-- Sticky Pull Request Comment -->
         body-include: '<!-- Sticky Pull Request Comment -->'
         number: ${{ steps.pr.outputs.pr_id }}

preview/action.yml

@@ -0,0 +1,61 @@
+name: Create PR Preview
+
+inputs:
+  github-token:
+    description: 'Github token used to create PR comments'
+    required: true
+  localstack-api-key:
+    description: 'LocalStack API key used to create the preview environment'
+    required: true
+  preview-cmd:
+    description: 'Command(s) used to create a preview of the PR (can use $AWS_ENDPOINT_URL)'
+    required: false
+    default: ''
+
+runs:
+  using: composite
+  steps:
+    - name: Initial PR comment
+      # TODO: potentially replace with Action version number over time
+      uses: LocalStack/setup-localstack/prepare@main
+      if: inputs.github-token
+      with:
+        github-token: ${{ inputs.github-token }}
+
+    - name: Download PR artifact
+      uses: actions/download-artifact@v3
+      with:
+        name: pr
+
+    - name: Create preview environment
+      shell: bash
+      run: |
+        prId=$(<pr-id.txt)
+        # TODO: make preview name configurable!
+        previewName=preview-$prId
+
+        response=$(curl -X POST -d '{}' \
+            -H 'authorization: token ${{ inputs.localstack-api-key }}' \
+            -H 'content-type: application/json' \
+            https://api.localstack.cloud/v1/previews/$previewName)
+        endpointUrl=$(echo "$response" | jq -r .endpoint_url)
+        if [ "$endpointUrl" = "null" ] || [ "$endpointUrl" = "" ]; then
+          echo "Unable to create preview environment. API response: $response"
+          exit 1
+        fi
+        echo "Created preview environment with endpoint URL: $endpointUrl"
+
+        echo $endpointUrl > ./ls-preview-url.txt
+        echo "LS_PREVIEW_URL=$endpointUrl" >> $GITHUB_ENV
+        echo "AWS_ENDPOINT_URL=$endpointUrl" >> $GITHUB_ENV
+
+    - name: Upload preview instance URL
+      uses: actions/upload-artifact@v3
+      with:
+        name: pr
+        path: ./ls-preview-url.txt
+
+    - name: Run preview deployment
+      shell: bash
+      run:
+        ${{ inputs.preview-cmd }}