start: add 'payload' parameter (#87)

Author: bobheadxi

README.md

@@ -84,6 +84,7 @@ In addition to the [core configuration](#configuration), the following [`inputs`
 | --------------- | ------- | --------------------------------------------------------------------------------------------------- |
 | `deployment_id` |         | Use an existing deployment instead of creating a new one (e.g. `${{ github.event.deployment.id }}`) |
 | `override`      | `false` | whether to mark existing deployments of this environment as inactive                                |
+| `payload`       |         | JSON-formatted dictionary with extra information about the deployment                               |
 
 The following [`outputs`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions#steps-context) are available:
 
@@ -161,13 +162,13 @@ This is best used after `step: start` and should follow whatever deployment task
 
 In addition to the [core configuration](#configuration), the following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswith) are available:
 
-| Variable        | Default | Purpose                                                                           |
-| --------------- | ------- | --------------------------------------------------------------------------------- |
-| `status`        |         | provide the current deployment job status `${{ job.status }}`                     |
-| `deployment_id` |         | identifier for deployment to update (see outputs of [`step: start`](#step-start)) |
-| `env_url`       |         | URL to view deployed environment                                                  |
-| `override`      | `true`  | whether to manually mark existing deployments of this environment as inactive              |
-| `auto_inactive`      | `true`  | whether to let GitHub handle marking existing deployments of this environment as inactive ([if and only if a new deployment succeeds](https://docs.github.com/en/rest/reference/deployments#inactive-deployments)). |
+| Variable        | Default | Purpose                                                                                                                                                                                                             |
+| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `status`        |         | provide the current deployment job status `${{ job.status }}`                                                                                                                                                       |
+| `deployment_id` |         | identifier for deployment to update (see outputs of [`step: start`](#step-start))                                                                                                                                   |
+| `env_url`       |         | URL to view deployed environment                                                                                                                                                                                    |
+| `override`      | `true`  | whether to manually mark existing deployments of this environment as inactive                                                                                                                                       |
+| `auto_inactive` | `true`  | whether to let GitHub handle marking existing deployments of this environment as inactive ([if and only if a new deployment succeeds](https://docs.github.com/en/rest/reference/deployments#inactive-deployments)). |
 
 <details>
 <summary>Simple Example</summary>

action.yml

@@ -52,3 +52,6 @@ inputs:
     required: false
     description: Whether to mark existing deployments as inactive if a deployment succeeds (for `finish` only)
     default: 'false'
+  payload:
+    required: false
+    description: JSON-formatted dictionary with extra information about the deployment (for `start` only)

dist/index.js

@@ -30,9 +30,15 @@ export async function run(
     switch (step) {
       case Step.Start:
         {
+          const rawPayload = getOptionalInput("payload");
+          let payload: { [key: string]: any } | undefined = undefined;
+          if (rawPayload) {
+            payload = JSON.parse(rawPayload);
+          }
           const stepArgs: StartArgs = {
             deploymentID: getOptionalInput("deployment_id"),
             override: getBooleanInput("override", false), // default to false on start
+            payload,
           };
           log.debug(`'${step}' arguments`, {
             stepArgs,

dist/index.js.map

@@ -6,6 +6,7 @@ import deactivateEnvironment from "../lib/deactivate";
 export type StartArgs = {
   deploymentID?: string;
   override: boolean;
+  payload?: { [key: string]: any };
 };
 
 async function createStart(
@@ -37,6 +38,7 @@ async function createStart(
       description: description,
       auto_merge: false,
       transient_environment: true,
+      payload: stepArgs.payload,
     });
     if (deployment.status == 201) {
       deploymentID = deployment.data.id;