feat: add task input (#141)

Hi 👋🏻 
This PR adds a `task` input, that lets you change the task assigned to the deployment.

Other housekeeping changes:
- `test` script added to `package.json`
- `getOptionalInput` now can actually return `undefined` (empty strings can cause API errors)
- the CI workflow can now be used on other repos

Closes #140

Author: EndBug

.github/workflows/pipeline.yaml

@@ -84,6 +84,15 @@ jobs:
         desc: 'Deployment starting!'
         debug: true
 
+    - name: parse repo name and owner
+      id: parse_repo
+      shell: bash
+      # outputs: owner, name
+      run: |
+        echo "owner=$(cut -d "/" -f 1 <<<"${{ github.repository }}")" >> $GITHUB_OUTPUT
+        echo "name=$(cut -d "/" -f 2 <<<"${{ github.repository }}")" >> $GITHUB_OUTPUT
+
+
     - name: assert deployment in progress
       uses: actions/github-script@v6
       env:
@@ -99,8 +108,8 @@ jobs:
             throw new Error("status_id not set");
           }
           const res = await github.rest.repos.getDeploymentStatus({
-            owner: "bobheadxi",
-            repo: "deployments",
+            owner: "${{ steps.parse_repo.outputs.owner }}",
+            repo: "${{ steps.parse_repo.outputs.name }}",
             deployment_id: parseInt(deployment_id, 10),
             status_id: parseInt(status_id, 10),
           });
@@ -137,8 +146,8 @@ jobs:
             throw new Error("status_id not set");
           }
           const res = await github.rest.repos.getDeploymentStatus({
-            owner: "bobheadxi",
-            repo: "deployments",
+            owner: "${{ steps.parse_repo.outputs.owner }}",
+            repo: "${{ steps.parse_repo.outputs.name }}",
             deployment_id: parseInt(deployment_id, 10),
             status_id: parseInt(status_id, 10),
           });

README.md

@@ -82,11 +82,13 @@ This is best used on the `push: { branches: [ ... ] }` event, but you can also h
 
 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                                                                                             |
-| --------------- | ------- | --------------------------------------------------------------------------------------------------- |
-| `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                               |
+| Variable        | Default    | Purpose                                                                                             |
+| --------------- | -------    | --------------------------------------------------------------------------------------------------- |
+| `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                               |
+| `task`          | `'deploy'` | change the task associated with this deployment, can be any string
+
 
 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:
 

action.yml

@@ -31,6 +31,9 @@ inputs:
   ref:
     required: false
     description: The git ref to use for the deploy, defaults to `github.ref`
+  task:
+    required: false
+    description: The task to assign to the deployment, defaults to 'deploy'
 
   debug:
     required: false

dist/index.js

@@ -8,7 +8,8 @@
     "prettier": "prettier src --write",
     "prettier:check": "prettier src --check",
     "build": "ncc build src/main.ts --out dist --minify --source-map --license LICENSES",
-    "build:check": "npm run build && git diff --quiet dist"
+    "build:check": "npm run build && git diff --quiet dist",
+    "test": "npm run prettier:check & npm run build:check"
   },
   "repository": {
     "type": "git",

dist/index.js.map

@@ -8,6 +8,7 @@ export interface DeploymentContext {
   owner: string;
   repo: string;
   log: Logger;
+  task: string | undefined;
 
   coreArgs: {
     description?: string;
@@ -36,6 +37,7 @@ export function collectDeploymentContext(): DeploymentContext {
     sha,
     owner,
     repo,
+    task: getOptionalInput("task"),
     log: new Logger({ debug: getBooleanInput("debug", false) }),
     coreArgs: {
       environment: getRequiredInput("env"),

package.json

@@ -17,5 +17,5 @@ export function getRequiredInput(key: string): string {
 }
 
 export function getOptionalInput(key: string): string | undefined {
-  return getInput(key, { required: false, trimWhitespace: true });
+  return getInput(key, { required: false, trimWhitespace: true }) || undefined;
 }

src/lib/context.ts

@@ -23,6 +23,7 @@ async function createStart(
     owner,
     repo,
     ref,
+    task,
     coreArgs: { environment, description, logsURL },
   } = context;
 
@@ -33,6 +34,7 @@ async function createStart(
       owner: owner,
       repo: repo,
       ref: ref,
+      task: task,
       required_contexts: [],
       environment: environment,
       description: description,