Merge branch 'main' into dependabot/npm_and_yarn/follow-redirects-1.15.6

OctopusDeploy · Feb 19, 2025 · 3ee1654 · 3ee1654
2 parents 07308e3 + fab4b76
commit 3ee1654
Show file tree

Hide file tree

Showing 12 changed files with 3,978 additions and 3,107 deletions.
diff --git a/.github/workflows/dist.yml b/.github/workflows/dist.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          token: ${{ secrets.INTEGRATIONS_FNM_BOT_TOKEN }}
+          token: ${{ secrets.DEVEX_BOT_TOKEN }}
 
       - name: Setup node 20
         uses: actions/setup-node@v3
@@ -35,8 +35,8 @@ jobs:
 
       - name: commit
         run: |-
-          git config --global user.name "team-integrations-fnm-bot"
-          git config user.email 'integrationsfnmbot@octopus.com'
+          git config --global user.name "team-github-bot"
+          git config user.email 'team-github-bot@octopus.com'
           git add README.md
           git add dist/
           git diff-index --quiet HEAD || (git commit -m "chore: build dist and update README" && git push origin)
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -38,7 +38,7 @@ jobs:
       - id: release-pr
         uses: google-github-actions/release-please-action@v3
         with:
-          token: ${{ secrets.INTEGRATIONS_FNM_BOT_TOKEN }}
+          token: ${{ secrets.DEVEX_BOT_TOKEN }}
           release-type: node
           package-name: ${{env.ACTION_NAME}}
           command: release-pr
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       sqlserver:
-        image: mcr.microsoft.com/mssql/server:2019-latest
+        image: mcr.microsoft.com/mssql/server:2019-CU27-ubuntu-20.04
         env:
           ACCEPT_EULA: Y
           SA_PASSWORD: ${{ env.SA_PASSWORD }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [3.3.0](https://github.com/OctopusDeploy/run-runbook-action/compare/v3.2.1...v3.3.0) (2024-12-18)
+
+
+### Features
+
+* Added Git Runbook support ([#432](https://github.com/OctopusDeploy/run-runbook-action/issues/432)) ([5d47e3d](https://github.com/OctopusDeploy/run-runbook-action/commit/5d47e3d695793db309166fa556fa90b8f5d3c1da))
+
 ## [3.2.1](https://github.com/OctopusDeploy/run-runbook-action/compare/v3.2.0...v3.2.1) (2024-02-04)
 
 

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1 @@
-* @OctopusDeploy/team-github
+* @OctopusDeploy/team-devex
diff --git a/README.md b/README.md
@@ -4,6 +4,9 @@
 
 This is a GitHub Action that will run a [runbook](https://octopus.com/docs/runbooks) in Octopus Deploy.
 
+> [!IMPORTANT]
+> As of **v3** of this action, Octopus Server version `2022.3.5512` or newer is required.
+
 ## Migration Guide(s)
 
 Please refer to the [migration guide](migration-guide.md) if moving between major versions of this action.
@@ -38,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:
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		* @OctopusDeploy/team-github
		* @OctopusDeploy/team-devex