feat: Added Git Runbook support (#432)

* Added Git Runbook support * Upgraded to latest API client * Include built action file
OctopusDeploy · Dec 18, 2024 · 5d47e3d · 5d47e3d
1 parent 563a67b
commit 5d47e3d
Show file tree

Hide file tree

Showing 7 changed files with 372 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -41,15 +41,16 @@ steps:
 
 ## 📥 Inputs
 
-| Name           | Description                                                                                                                                                                                                  |
-| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `project`      | **Required.** The name of the project associated with this runbook.                                                                                                                                          |
-| `runbook`      | **Required.** The name of the runbook.                                                                                                                                                                       |
-| `environments` | **Required.** A list of environments in Octopus Deploy in which to run (i.e. Dev, Test, Prod). Each environment should be added on a new line.                                                                                              |
-| `variables`    | A multi-line list of prompted variable values. Format: name:value.                                                                                                                                           |
-| `server`       | 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`      | The API key used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret. |
-| `space`        | 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.                                                     |
+| Name           | Description                                                                                                                                                                                                                |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `project`      | **Required.** The name of the project associated with this runbook.                                                                                                                                                        |
+| `runbook`      | **Required.** The name of the runbook.                                                                                                                                                                                     |
+| `environments` | **Required.** A list of environments in Octopus Deploy in which to run (i.e. Dev, Test, Prod). Each environment should be added on a new line.                                                                             |
+| `variables`    | A multi-line list of prompted variable values. Format: name:value.                                                                                                                                                         |
+| `server`       | 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`      | The API key used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret.               |
+| `space`        | 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.                                                                   |
+| `git_ref`      | Git branch reference to the specific resources of a version controlled Octopus Project. This is required for version controlled projects. E.g. ${{ github.ref }} to use the branch or tag ref that triggered the workflow. |
 
 ## 📤 Outputs
 

diff --git a/action.yml b/action.yml
@@ -30,6 +30,8 @@ inputs:
     description: 'The API key used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret.'
   space:
     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.'
+  git_ref:
+    description: 'The Git Reference on which to run the Runbook. If not populate the action assumes you are running a DB Runbook. In most cases when running a Git Runbook this will be your default branch refs/heads/main'
 
 outputs:
   server_tasks: