Merge pull request #26 from dhollerbach/feat/version-bump

feat/version-bump

Author: dhollerbach

.github/workflows/integration-tests.yaml

@@ -0,0 +1,50 @@
+name: Integration Tests
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  serverless-deploy:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        examples: [
+          ./examples/aws_credentials,
+          ./examples/serverless_access_key
+        ]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-east-1
+
+      - name: Serverless Deploy (AWS Credentials)
+        if: ${{ matrix.examples == './examples/aws_credentials' }}
+        uses: ./
+        with:
+          framework: 3.26.0
+          working-directory: ${{ matrix.examples }}
+
+      - name: Serverless Deploy (Serverless Access Key)
+        if: ${{ matrix.examples == './examples/serverless_access_key' }}
+        uses: ./
+        with:
+          serverless-access-key: ${{ secrets.SERVERLESS_ACCESS_KEY }}
+          working-directory: ${{ matrix.examples }}

README.md

@@ -1,57 +1,70 @@
-# Serverless with Python Requirements
+# Serverless with Python Requirements  
 
-Javascript action that runs a Serverless deploy using the serverless-python-requirements plugin.
+JavaScript GitHub Action that runs a Serverless deploy using the `serverless-python-requirements` plugin.  
+It also supports optional plugins such as `serverless-domain-manager` and `serverless-plugin-canary-deployments`.  
 
-## Environment Variables
+See [examples](./examples/) for multiple example configurations.
 
-### `aws-access-key-id`
+## Inputs  
 
-**Conditional** Your aws access key id.
+| Name                                    | Required     | Description  |
+|-----------------------------------------|--------------|--------------|
+| `aws-access-key-id`                     | **Conditional** | AWS Access Key ID. Required if using AWS credentials instead of Serverless Access Key. Serverless V4 requires a Serverless access key. |
+| `aws-secret-access-key`                 | **Conditional** | AWS Secret Access Key. Required if using AWS credentials instead of Serverless Access Key. Serverless V4 requires a Serverless access key. |
+| `framework`                             | **Optional** | The Serverless framework version to install. Defaults to latest. |
+| `serverless-access-key`                 | **Conditional** | Serverless access key. Required if not using AWS credentials. Serverless V4 requires a Serverless access key. |
+| `working-directory`                     | **Optional** | The working directory to run Serverless deploy in. Must contain the Serverless config file (e.g. serverless.yaml, serverless.yml). Defaults to the current directory. |
 
-### `aws-secret-access-key`
+## Example Usage  
 
-**Conditional** Your aws secret access key.
-
-### `serverless-access-key`
-
-**Conditional** Your serverless access key.
-
-## Example usage
-
-#### AWS Credentials
+### AWS Credentials  
+```yaml
+- name: Serverless Deploy
+  uses: dhollerbach/actions.serverless-with-python-requirements@v3
+  with:
+    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 ```
-- name: Setup Node
-  uses: actions/setup-node@v3
+
+### Serverless Access Key (required if using Serverless V4)
+```yaml
+- name: Serverless Deploy
+  uses: dhollerbach/actions.serverless-with-python-requirements@v3
   with:
-    node-version: 16
+    serverless-access-key: ${{ secrets.SERVERLESS_ACCESS_KEY }}
+```
 
-- name: Setup Python
-  uses: actions/setup-python@v4
+### Separate AWS Credentials Step
+```yaml
+- name: Configure AWS Credentials
+  uses: aws-actions/configure-aws-credentials@v4
   with:
-    python-version: 3.8 
+    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+    aws-region: us-east-1
 
 - name: Serverless Deploy
-  uses: dhollerbach/actions.serverless-with-python-requirements@v2
-  env:
-    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-    STAGE: dev
-```
-#### Serverless Access Key
-```
-- name: Setup Node
-  uses: actions/setup-node@v3
+  uses: dhollerbach/actions.serverless-with-python-requirements@v3
   with:
-    node-version: 16
+    serverless-access-key: ${{ secrets.SERVERLESS_ACCESS_KEY }}
+```
 
-- name: Setup Python
-  uses: actions/setup-python@v4
+### Directory Other Than Root
+```yaml
+- name: Serverless Deploy
+  uses: dhollerbach/actions.serverless-with-python-requirements@v3
   with:
-    python-version: 3.8 
+    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+    working-directory: ./examples/
+```
 
+### Specific Serverless Framework
+```yaml
 - name: Serverless Deploy
-  uses: dhollerbach/actions.serverless-with-python-requirements@v2
-  env:
-    SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }}
-    STAGE: dev
+  uses: dhollerbach/actions.serverless-with-python-requirements@v3
+  with:
+    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+    framework: 3.26.0
 ```

action.yml

@@ -1,10 +1,35 @@
-name: 'Serverless with Python Requirements'
-description: 'Javascript action that runs a Serverless deploy using the serverless-python-requirements plugin.'
+name: Serverless with Python Requirements
+description: JavaScript action that runs a Serverless deploy using the serverless-python-requirements plugin.
 
 runs:
-  using: 'node16'
-  main: 'index.js'
+  using: node20
+  main: index.js
 
 branding:
-  icon: 'fast-forward'
-  color: 'red'
+  icon: fast-forward
+  color: red
+
+inputs:
+  aws-access-key-id:
+    description: AWS Access Key ID. Required if using AWS credentials instead of Serverless Access Key. Serverless V4 requires a serverless access key.
+    required: false
+    default: ''
+
+  aws-secret-access-key:
+    description: AWS Secret Access Key. Required if using AWS credentials instead of Serverless Access Key. Serverless V4 requires a serverless access key.
+    required: false
+    default: ''
+
+  framework:
+    description: The Serverless framework version to install.
+    required: false
+
+  serverless-access-key:
+    description: Serverless access key. Required if not using AWS credentials. Serverless V4 requires a serverless access key.
+    required: false
+    default: ''
+
+  working-directory:
+    description: The working directory to run Serverless deploy in. Must contain the Serverless config file (e.g. serverless.yaml, serverless.yml).
+    required: false
+    default: '.'

examples/.github/workflows/serverless.yaml

@@ -0,0 +1,16 @@
+service: aws-credentials
+
+frameworkVersion: '3'
+
+provider:
+  name: aws
+  runtime: python3.9
+  stage: dev
+
+functions:
+  hello:
+    handler: handler.hello
+
+plugins:
+  - serverless-plugin-canary-deployments
+  - serverless-python-requirements

examples/handler.py examples/aws_credentials/handler.pyexamples/handler.py renamed to examples/aws_credentials/handler.py

@@ -0,0 +1,25 @@
+import json
+import boto3
+
+
+def hello(event, context):
+    body = {
+        "message": "Go Serverless v1.0! Your function executed successfully!",
+        "input": event
+    }
+
+    response = {
+        "statusCode": 200,
+        "body": json.dumps(body)
+    }
+
+    return response
+
+    # Use this code if you don't use the http event with the LAMBDA-PROXY
+    # integration
+    """
+    return {
+        "message": "Go Serverless v1.0! Your function executed successfully!",
+        "event": event
+    }
+    """

examples/requirements.txt examples/aws_credentials/requirements.txtexamples/requirements.txt renamed to examples/aws_credentials/requirements.txt

@@ -0,0 +1 @@
+boto3