feat: Add GitHub Action to deprovision an ephemeral environment

.eslintrc.json

@@ -24,6 +24,7 @@
   },
   "ignorePatterns": [
     "dist/**/*",
+    "out/**/*",
     "*.js"
   ]
 }

.github/workflows/test-deprovision-environment.yml

@@ -1,4 +1,42 @@
-name: Test Deprovision Ephemeral Environment
+name: Test Deprovision Environment
 
 on:
-  workflow_dispatch:
+  workflow_dispatch:
+    inputs:
+      name:
+        description: 'The name of the ephemeral environment to deprovision.'
+        required: true
+      server:
+        type: string
+        description: The url of the Octopus Instance. Will default to repository variable TEST_INSTANCE_URL if not supplied.
+      service_account_id:
+        type: string
+        description: The id of the service account to login for. Will default to repository variable TEST_INSTANCE_SERVICE_ACCOUNT_ID if not supplied.
+      space:
+        description: 'The name of the space containing the ephemeral environment. Will default to repository variable TEST_SPACE_NAME if not supplied.'
+
+jobs:
+  deprovision-environment:
+    permissions:
+      id-token: write # This is required for requesting the JWT
+      contents: read # This is required for actions/checkout
+    runs-on: ubuntu-latest
+    name: Test Ephemeral Environment Deprovisioning
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Login to Octopus Deploy
+        uses: OctopusDeploy/login@v1
+        with: 
+          server: ${{ inputs.server || vars.TEST_INSTANCE_URL }}
+          service_account_id: ${{ inputs.service_account_id || vars.TEST_INSTANCE_SERVICE_ACCOUNT_ID }}
+
+      - name: Deprovision Ephemeral Environment
+        id: self_test
+        uses: ./
+        with:
+          name: ${{ inputs.name }}
+          space: ${{ inputs.space || vars.TEST_SPACE_NAME}}
+
+      - name: Show Test Action Output
+        run: echo "${{ steps.self_test.outputs.deprovisioning_runbook_runs }}"

.gitignore

@@ -1,5 +1,5 @@
 node_modules/
-dist/
+out/
 coverage/
 test-results/
 *.log

action.yml

@@ -0,0 +1,25 @@
+name: 'Deprovision an ephemeral environment in Octopus Deploy'
+description: 'GitHub Action to deprovision an ephemeral environment across all projects in Octopus Deploy'
+author: 'Octopus Deploy'
+branding:
+  color: 'blue'
+  icon: 'package'
+
+inputs:
+  name:
+    description: 'The name of the ephemeral environment to deprovision.'
+    required: true
+  space:
+    description: 'The name of the space containing the ephemeral environment. The space name is required, but you may also use the OCTOPUS_SPACE environment variable.'
+  server:
+    description: 'The instance URL hosting Octopus Deploy (i.e. "https://octopus.example.com/"). The instance URL is required, but you may also use the OCTOPUS_URL environment variable.'
+  api_key:
+    description: 'The API key used to access Octopus Deploy. You may also use the OctopusDeploy Login Action, OCTOPUS_API_KEY environment variable or OCTOPUS_ACCESS_TOKEN environment variable. It is strongly recommended that this value be retrieved from a GitHub secret.'
+
+outputs:
+  deprovisioning_runbook_runs:
+    description: 'JSON string for an array of objects representing the deprovisioning runbook runs started by this action. Each object contains a `runbookRunId` and `serverTaskId`.'
+
+runs:
+  using: 'node24'
+  main: 'dist/index.js'