Changed the task output and fixed an error handling bug in the task w…

…aiter (#4)

.github/workflows/test.yml

@@ -83,4 +83,18 @@ jobs:
         server_task_id: ${{ steps.npm_tests.outputs.gha_selftest_server_task_id }} # see integration.test.ts
 
     - name: Echo success status from self-test
-      run: echo "Deployment succeeded = [${{ steps.self_test.outputs.completed_successfully }}]"
+      run: echo "Deployment succeeded = [${{ steps.self_test.outputs.task_state }}]"
+
+    - name: GitHub Action self-test-2
+      id: self_test_2
+      uses: ./
+      continue-on-error: true
+      env:
+        OCTOPUS_URL: ${{ env.SERVER_URL }}
+        OCTOPUS_API_KEY: ${{ env.ADMIN_API_KEY }}
+        OCTOPUS_SPACE: 'Default'
+      with:
+        server_task_id: 'ServerTasks-99999'
+
+    - name: Echo success status from self-test-2
+      run: echo "Deployment succeeded = [${{ steps.self_test_2.outputs.task_state }}]"

README.md

@@ -58,9 +58,9 @@ steps:
 
 ## 📤 Outputs
 
-| Name                     | Description                                                        |
-| :----------------------- | :----------------------------------------------------------------- |
-| `completed_successfully` | Boolean indicating whether the task completed successfully or not. |
+| Name         | Description                                                                                                                                                                                                                                               |
+| :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `task_state` | The final [TaskState](https://github.com/OctopusDeploy/api-client.ts/blob/main/src/features/serverTasks/taskState.ts) (Canceled, Failed, Success, or TimedOut) returned from Octopus, or undefined if Octopus couldn't be contacted to retrieve the state |
 
 ## 🤝 Contributions
 

__tests__/integration/integration.test.ts

@@ -19,7 +19,8 @@ import {
   RunCondition,
   RunConditionForAction,
   SpaceRepository,
-  StartTrigger
+  StartTrigger,
+  TaskState
 } from '@octopusdeploy/api-client'
 import { randomBytes } from 'crypto'
 import { setOutput } from '@actions/core'
@@ -225,9 +226,9 @@ describe('integration tests', () => {
     const space = (await spaceRepository.list({ partialName: spaceName })).Items[0]
 
     // The first release in the project, so it should always have 0.0.1
-    expect(result).toBe(true)
+    expect(result).toBe(TaskState.Success)
     expect(output.getAllMessages()).toContain(
-      `[INFO] 🐙 waiting for task [${standardInputParameters.serverTaskId}](${standardInputParameters.server}/app#/${space.Id}/tasks/${standardInputParameters.serverTaskId}) in Octopus Deploy...`
+      `[INFO] 🐙 waiting for task ${standardInputParameters.server}/app#/${space.Id}/tasks/${standardInputParameters.serverTaskId} in Octopus Deploy...`
     )
 
     // re-queue another deployment to the same environment, which the self test is going to wait for via localServerTaskId

action.yml

@@ -26,8 +26,8 @@ inputs:
     description: 'The name of a space within which this command will be executed. The space name is required, but you may also use the OCTOPUS_SPACE environment variable.'
 
 outputs:
-  completed_successfully:
-    description: 'Boolean indicating whether the task completed successfully or not.'
+  task_state:
+    description: 'The final TaskState (Canceled, Failed, Success, or TimedOut) returned from Octopus, or undefined if Octopus could not be contacted to retrieve the state. '
 
 runs:
   using: 'node16'

package.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@octopusdeploy/api-client": "^2.0.0",
+    "@octopusdeploy/api-client": "^2.1.0",
     "tmp": "^0.2.1"
   },
   "description": "GitHub Action to Create a Release in Octopus Deploy",

src/api-wrapper.ts

@@ -6,10 +6,10 @@ export interface DeploymentResult {
   environmentName: string
 }
 
-export async function waitForTask(client: Client, parameters: InputParameters): Promise<boolean> {
+export async function waitForTask(client: Client, parameters: InputParameters): Promise<TaskState | undefined> {
   const spaceId = await resolveSpaceId(client, parameters.space)
   client.info(
-    `🐙 waiting for task [${parameters.serverTaskId}](${parameters.server}/app#/${spaceId}/tasks/${parameters.serverTaskId}) in Octopus Deploy...`
+    `🐙 waiting for task ${parameters.server}/app#/${spaceId}/tasks/${parameters.serverTaskId} in Octopus Deploy...`
   )
 
   const waiter = new ServerTaskWaiter(client, parameters.space)
@@ -26,5 +26,5 @@ export async function waitForTask(client: Client, parameters: InputParameters):
     }
   )
 
-  return serverTask?.State === TaskState.Success
+  return serverTask?.State
 }

src/index.ts

@@ -1,7 +1,7 @@
 import { getInputParameters } from './input-parameters'
 import { debug, info, warning, error, setFailed, setOutput, isDebug } from '@actions/core'
 import { writeFileSync } from 'fs'
-import { Client, ClientConfiguration, Logger } from '@octopusdeploy/api-client'
+import { Client, ClientConfiguration, Logger, TaskState } from '@octopusdeploy/api-client'
 import { waitForTask } from './api-wrapper'
 
 // GitHub actions entrypoint
@@ -35,20 +35,26 @@ import { waitForTask } from './api-wrapper'
 
     const client = await Client.create(config)
 
-    const completedSuccessfully = await waitForTask(client, parameters)
+    const taskState = await waitForTask(client, parameters)
 
-    setOutput('completed_successfully', completedSuccessfully)
+    setOutput('task_state', taskState)
 
     const stepSummaryFile = process.env.GITHUB_STEP_SUMMARY
     if (stepSummaryFile) {
       writeFileSync(
         stepSummaryFile,
-        `🐙 Octopus Deploy task ${completedSuccessfully ? 'completed successfully' : 'did not complete successfully'}.`
+        `🐙 Octopus Deploy task ${
+          taskState === TaskState.Success ? 'completed successfully' : 'did not complete successfully'
+        }.`
       )
     }
 
-    if (!completedSuccessfully) {
-      setFailed('🐙 Octopus Deploy task did not complete successfully')
+    if (taskState !== TaskState.Success) {
+      if (taskState) {
+        setFailed(`🐙 Octopus Deploy task did not complete successfully (state: ${taskState})`)
+      } else {
+        setFailed('🐙 Could not determine Octopus Deploy task state')
+      }
     }
   } catch (e: unknown) {
     if (e instanceof Error) {