Cleanup

Author: antonpirker

.github/workflows/test.yml renamed to .github/workflows/test_production.yml

@@ -1,12 +1,12 @@
-name: Test
+name: Test Production
 
 on:
   workflow_dispatch:
     inputs:
       debug_enabled:
-        description: "Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)"
+        description: "Run the build with tmate debugging enabled (true/false)?  (see https://github.com/marketplace/actions/debugging-with-tmate)"
         required: false
-        default: false
+        default: "false"
 
 env:
   BUILD_CACHE_KEY: ${{ github.sha }}
@@ -16,7 +16,7 @@ env:
 jobs:
   test:
     runs-on: ubuntu-latest
-    name: "Test Lambda Layer Build"
+    name: "Test Lambda Layer Build (the current v1 that is in production, not the code from the branch)"
     steps:
       - name: Setup build cache
         uses: actions/cache@v2
@@ -36,3 +36,4 @@ jobs:
           zip_file_name: test-aws-lambda-layer.zip
           build_cache_paths: ${{ env.CACHED_BUILD_PATHS }}
           build_cache_key: ${{ env.BUILD_CACHE_KEY }}
+          debug_enabled: ${{ github.event.inputs.debug_enabled }}

README.md

@@ -41,6 +41,10 @@ steps:
         zip_file_name: sentry-python-serverless.zip
 ```
 
+This test script illustrates the usage of the action:
+
+[.github/workflows/test_production.yml](.github/workflows/test_production.yml)
+
 For an full example usage see the Sentry Python SDK:
 
 https://github.com/getsentry/sentry-python/blob/master/.github/workflows/ci.yml
@@ -49,12 +53,17 @@ https://github.com/getsentry/sentry-python/blob/master/.github/workflows/ci.yml
 
 The following are all _required_.
 
-| name                | description                                                                   |
-| ------------------- | ----------------------------------------------------------------------------- |
-| `artifact_name`     | Name of the prepared articact the Lambda Layer zip file should be uploaded to |
-| `zip_file_name`     | Name of the zip file that will be created                                     |
-| `build_cache_key`   | Build cache key                                                               |
-| `build_cache_paths` | Paths of the build cache                                                      |
+| name                | description                                                                                                                                      |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `artifact_name`     | Name of the prepared articact the Lambda Layer zip file should be uploaded to                                                                    |
+| `zip_file_name`     | Name of the zip file that will be created                                                                                                        |
+| `build_cache_key`   | Build cache key                                                                                                                                  |
+| `build_cache_paths` | Paths of the build cache                                                                                                                         |
+| `debug_enabled`     | If set to "true" debugging is enabled and you can log into the running action. (See https://github.com/marketplace/actions/debugging-with-tmate) |
+
+## Testing
+
+If you want to see an example of a zip file this action can create looks like you can manually run the GitHub action "Test Production". This will create a dummy lambda layer (just containing one placeholder file) and the latest [relay](https://github.com/getsentry/relay) based Sentry Lambda Extension. After the GitHub action has run, you can download the generated artifact at the bottom of the summary page of the GitHub action result.
 
 ## Contributing
 

action.yml

@@ -1,46 +1,45 @@
 name: "Build AWS Lambda Layer"
 description: "Creates a Lambda layer including the Sentry SDK and the Sentry Lambda extension."
+
 inputs:
   artifact_name:
-    description: Name of the prepared articact the Lambda Layer zip file should be uploaded to
+    description: "Name of the prepared articact the Lambda Layer zip file should be uploaded to"
     required: true
   zip_file_name:
-    description: Name of the zip file that will be created
+    description: "Name of the zip file that will be created"
     required: true
   build_cache_key:
-    description: Build cache key
+    description: "Build cache key"
     required: true
   build_cache_paths:
-    description: Paths of the build cache
+    description: "Paths of the build cache"
     required: true
-on:
-  workflow_dispatch:
-    inputs:
-      debug_enabled:
-        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'     
-        required: false
-        default: false
+  debug_enabled:
+    description: 'Run the build with tmate debugging enabled? (https://github.com/marketplace/actions/debugging-with-tmate)'
+    required: false
+    default: "false"
+
 runs:
   using: "composite"
   steps:
-    - name: Check build cache
+    - name: "Check build cache"
       uses: actions/cache@v2
       id: cache_built_packages
       with:
         path: ${{ inputs.build_cache_paths }}
         key: ${{ inputs.build_cache_key }}
-    - name: Download and configure Sentry Lambda extension
+    - name: "Download and configure Sentry Lambda extension"
       shell: bash
       run: |
         echo "Downloading Sentry Lambda extension..."
         mkdir -p dist-serverless/extensions
         curl -0 --silent --output dist-serverless/extensions/sentry-lambda-extension `curl -s https://release-registry.services.sentry.io/apps/sentry-lambda-extension/latest | jq -r .files.\"sentry-lambda-extension\".url`
         chmod +x dist-serverless/extensions/sentry-lambda-extension
         echo "Done downloading Sentry Lambda extension..."
-    - name: Setup tmate session
-        uses: mxschmitt/action-tmate@v3
-        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled }}        
-    - name: Create Lambda Layer zip
+    - name: "Setup tmate session"
+      uses: mxschmitt/action-tmate@v3
+      if: ${{ inputs.debug_enabled == 'true' }}
+    - name: "Create Lambda Layer zip"
       shell: bash
       run: |
         echo "Creating ${{ inputs.zip_file_name }}..."
@@ -52,10 +51,10 @@ runs:
 
         echo "Contents of the created zip file:"
         unzip -Z ${{ inputs.zip_file_name }}
-    - name: Setup tmate session
-        uses: mxschmitt/action-tmate@v3
-        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled }}        
-    - name: Upload zip (will be picked up by Craft for deployment)
+    - name: "Setup tmate session"
+      uses: mxschmitt/action-tmate@v3
+      if: ${{ inputs.debug_enabled == 'true' }}
+    - name: "Upload zip (will be picked up by Craft for deployment)"
       uses: actions/upload-artifact@v3
       with:
         name: ${{ inputs.artifact_name }}