support passing key/values when deploying (#27)

Signed-off-by: Rajat Jindal <[email protected]>
fermyon · Apr 26, 2023 · 571bb0a · 571bb0a
1 parent 7fd435a
commit 571bb0a
Show file tree

Hide file tree

Showing 10 changed files with 135 additions and 41 deletions.
diff --git a/.github/workflows/e2e-spin-deploy.yml b/.github/workflows/e2e-spin-deploy.yml
@@ -55,3 +55,6 @@ jobs:
         with:
           fermyon_token: ${{ secrets.FERMYON_CLOUD_TOKEN }}
           manifest_file: example-app/spin.toml
+          key_values: |-
+            abc=xyz
+            foo=bar
diff --git a/README.md b/README.md
@@ -151,7 +151,7 @@ Build and deploy the Spin app to Fermyon Cloud.
 | ------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | fermyon_token | True     | -         | [Fermyon Cloud Personal Access Token](https://developer.fermyon.com/cloud/user-settings.md#create-and-manage-a-personal-access-token) for deploying the Spin app to Fermyon Cloud |
 | manifest_file | False    | spin.toml | Path to `spin.toml`.                                                                                                                                                              |
-
+| key_values    | False    | -         | Pass a key/value (key=value) to all components of the application. You can specify multiple key_values by putting each key/value pair on its own line. Refer to example below.    |
 ### Example
 
 
@@ -179,6 +179,9 @@ jobs:
         with:
           manifest_file: example-app/spin.toml
           fermyon_token: ${{ secrets.FERMYON_CLOUD_TOKEN }}
+          key_values: |-
+            abc=xyz
+            foo=bar
 ```
 
 ## Deploy preview of Spin app to Fermyon Cloud - `fermyon/actions/spin/preview@v1`
@@ -193,12 +196,13 @@ If you don't run the preview action with undeploy on the closed event, your prev
 
 ### Inputs
 
-| Name          | Required | Default   | Description                                                                     |
-| ------------- | -------- | --------- | ------------------------------------------------------------------------------- |
-| fermyon_token | True     | -         | Fermyon Cloud Personal Access Token for deploying the Spin app to Fermyon Cloud |
-| manifest_file | False    | spin.toml | Path to `spin.toml`.                                                            |
-| github_token  | True     | -         | The GitHub token for adding a comment on PR with preview URL.                   |
-| undeploy      | False    | -         | If true, removes the preview deployment from Fermyon Cloud                      |
+| Name          | Required | Default   | Description                                                                                                                                                                    |
+| ------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| fermyon_token | True     | -         | Fermyon Cloud Personal Access Token for deploying the Spin app to Fermyon Cloud                                                                                                |
+| manifest_file | False    | spin.toml | Path to `spin.toml`.                                                                                                                                                           |
+| github_token  | True     | -         | The GitHub token for adding a comment on PR with preview URL.                                                                                                                  |
+| undeploy      | False    | -         | If true, removes the preview deployment from Fermyon Cloud                                                                                                                     |
+| key_values    | False    | -         | Pass a key/value (key=value) to all components of the application. You can specify multiple key_values by putting each key/value pair on its own line. Refer to example below. |
 
 ### Example
 
@@ -230,4 +234,7 @@ jobs:
           fermyon_token: ${{ secrets.FERMYON_CLOUD_TOKEN }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           undeploy: ${{ github.event.pull_request && github.event.action == 'closed' }}
+          key_values: |-
+            abc=xyz
+            foo=bar
 ```
diff --git a/dist/spin/deploy/index.js b/dist/spin/deploy/index.js
diff --git a/dist/spin/preview/index.js b/dist/spin/preview/index.js
diff --git a/dist/spin/push/index.js b/dist/spin/push/index.js
diff --git a/dist/spin/setup/index.js b/dist/spin/setup/index.js
diff --git a/spin/deploy/action.yml b/spin/deploy/action.yml
@@ -9,6 +9,9 @@ inputs:
   fermyon_token:
     required: false
     description: 'personal access token for Fermyon Cloud'
+  key_values:
+    required: false
+    description: 'Pass a key/value (key=value) to all components of the application. You can specify multiple key_values by putting each key/value pair on its own line'
 runs:
   using: 'node16'
   main: '../../dist/spin/deploy/index.js'
diff --git a/spin/preview/action.yml b/spin/preview/action.yml
@@ -15,6 +15,9 @@ inputs:
   undeploy:
     required: false
     description: 'if true, remove the preview deployment from Fermyon Cloud'  
+  key_values:
+    required: false
+    description: 'Pass a key/value (key=value) to all components of the application. You can specify multiple key_values by putting each key/value pair on its own line'
 runs:
   using: 'node16'
   main: '../../dist/spin/preview/index.js'