From a9908f3064b31a64fce6a10091844ce11d7eed5d Mon Sep 17 00:00:00 2001 From: Felix I Date: Wed, 11 Mar 2026 18:30:48 +1100 Subject: [PATCH 1/2] Updating public docs to reflect GitHub Connections in Platform Hub capabilities and limitations --- .../process-templates/troubleshooting.md | 33 ++++++++++--------- .../projects/version-control/github/index.md | 2 ++ 2 files changed, 19 insertions(+), 16 deletions(-) diff --git a/src/pages/docs/platform-hub/process-templates/troubleshooting.md b/src/pages/docs/platform-hub/process-templates/troubleshooting.md index b517ef29d7..d78343b9e8 100644 --- a/src/pages/docs/platform-hub/process-templates/troubleshooting.md +++ b/src/pages/docs/platform-hub/process-templates/troubleshooting.md @@ -31,7 +31,7 @@ If you are migrating an existing process to be used as a process template, you m For example, consider this script that directly references project and system variables via `OctopusParameters`. -``` +```powershell $packagePath = $OctopusParameters["Octopus.Action.Package[Trident.Database].ExtractedPath"] $connectionString = $OctopusParameters["Project.Connection.String"] $environmentName = $OctopusParameters["Octopus.Environment.Name"] @@ -54,7 +54,7 @@ The following variables should be updated to reference process templates paramet The `$environmentName` variable is fine, as system variables will continue to work as normal. The updated script will be: -``` +```powershell $packagePath = $OctopusParameters["Octopus.Action.Package[Template.Database.Package].ExtractedPath"] $connectionString = $OctopusParameters["Template.Database.ConnectionString"] $environmentName = $OctopusParameters["Octopus.Environment.Name"] @@ -81,8 +81,8 @@ A couple scenarios that demonstrate the scoping precedence: | Origin | Name | Value | Scope | |------------------|--------------|------------------|-------------| -| Process Template | AzureAccount | Account-123 | Development | -| Project | AzureAccount | Account-124 | Development | +| Process Template | AzureAccount | Account-123 | Development | +| Project | AzureAccount | Account-124 | Development | When deploying to the **Development** environment, **Account-124** would be used. @@ -92,8 +92,8 @@ When deploying to the **Development** environment, **Account-124** would be used | Origin | Name | Value | Scope | |------------------|--------------|------------------|-------------| -| Process Template | AzureAccount | Account-123 | Development | -| Project | AzureAccount | Account-124 | | +| Process Template | AzureAccount | Account-123 | Development | +| Project | AzureAccount | Account-124 | | When deploying to the **Development** environment, **Account-124** would be used. @@ -103,8 +103,8 @@ When deploying to the **Development** environment, **Account-124** would be used | Origin | Name | Value | Scope | |------------------|--------------|------------------|-------------| -| Process Template | AzureAccount | Account-123 | Development | -| Project | AzureAccount | Account-124 | Staging | +| Process Template | AzureAccount | Account-123 | Development | +| Project | AzureAccount | Account-124 | Staging | - When deploying to the **Development** environment, **Account-123** would be used. - When deploying to the **Staging** environment, **Account-124** would be used. @@ -155,7 +155,7 @@ See [CreateProcessTemplateUsageStep](https://github.com/OctopusDeploy/OctopusDep ### GitHub Connections -The GitHub Connection is not supported in Platform Hub. Only usernames and PATs. +GitHub Connections is supported in the Platform Hub, but it can only be used to configure Platform Hub version control. It can't be used on steps in templates. ### Losing access to an Octopus Enterprise license @@ -181,7 +181,7 @@ To reference output variables from process template steps, add `.ProcessTemplate When referencing an output variable in a step **inside a process template**, use the format: -``` +```powershell Octopus.ProcessTemplate.Action[StepName].Output.PropertyName ``` @@ -189,14 +189,15 @@ Octopus.ProcessTemplate.Action[StepName].Output.PropertyName When referencing an output variable in a step **outside a process template**, include the name of the process template usage step as it appears in the project. -``` +```text Octopus.ProcessTemplate[ProcessTemplateUsageStepName].Action[StepName].Output.PropertyName ``` #### Example + Consider a process template named **Build and Create Web App** containing a step that runs a script and publishes an output variable `FilePath`: -``` +```hcl name = "Build and Create Web App" description = "" @@ -213,7 +214,7 @@ step "run-a-script" { Reference the variable from another step **inside** the process template using: -``` +```text Octopus.ProcessTemplate.Action[Collect Details].Output.FilePath ``` @@ -221,7 +222,7 @@ Octopus.ProcessTemplate.Action[Collect Details].Output.FilePath When this process template is used in a project with a process template usage step named **Create Web App**: -``` +```hcl process_template "run-a-process-template" { name = "Create Web App" process_template_slug = "build-and-create-web-app" @@ -236,10 +237,10 @@ process_template "run-a-process-template" { Reference the variable from any other step in the process, which is **outside** the process template, using: -``` +```text Octopus.ProcessTemplate[Create Web App].Action[Collect Details].Output.FilePath ``` :::div{.hint} Use the name of the process template usage step from the project, not the name of the process template itself, when referencing output variables outside a process template. -::: \ No newline at end of file +::: diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index da9be88229..6444f34617 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -64,6 +64,8 @@ To connect a repository, you must be an administrator of the repository on GitHu You can currently use GitHub App Connections to connect to Configuration as Code projects. This removes the need for using Personal Access Tokens to connect to GitHub repositories, and allows users to commit as their GitHub users (rather than using a shared account). +You can also define GitHub Connections in the [Platform Hub](/docs/platform-hub). GitHub Connections defined in the Platform Hub can only be used to configure the Platform Hub's version control settings and can't be used in spaces. + ## Requested Permissions There are specific GitHub permissions that the Octopus GitHub App requests in order to perform it's tasks. From adc2d8d54b1b074a224d77923d17a4e36ce7553f Mon Sep 17 00:00:00 2001 From: Felix I Date: Thu, 12 Mar 2026 17:34:38 +1100 Subject: [PATCH 2/2] Code review changes --- .../docs/platform-hub/process-templates/troubleshooting.md | 2 +- src/pages/docs/projects/version-control/github/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/platform-hub/process-templates/troubleshooting.md b/src/pages/docs/platform-hub/process-templates/troubleshooting.md index d78343b9e8..7c1aecae41 100644 --- a/src/pages/docs/platform-hub/process-templates/troubleshooting.md +++ b/src/pages/docs/platform-hub/process-templates/troubleshooting.md @@ -155,7 +155,7 @@ See [CreateProcessTemplateUsageStep](https://github.com/OctopusDeploy/OctopusDep ### GitHub Connections -GitHub Connections is supported in the Platform Hub, but it can only be used to configure Platform Hub version control. It can't be used on steps in templates. +GitHub Connections is supported in Platform Hub, but it can only be used to configure Platform Hub version control. It can't be used on steps in templates. ### Losing access to an Octopus Enterprise license diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 6444f34617..c9055f4276 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -64,7 +64,7 @@ To connect a repository, you must be an administrator of the repository on GitHu You can currently use GitHub App Connections to connect to Configuration as Code projects. This removes the need for using Personal Access Tokens to connect to GitHub repositories, and allows users to commit as their GitHub users (rather than using a shared account). -You can also define GitHub Connections in the [Platform Hub](/docs/platform-hub). GitHub Connections defined in the Platform Hub can only be used to configure the Platform Hub's version control settings and can't be used in spaces. +You can also define GitHub Connections in [Platform Hub](/docs/platform-hub). GitHub Connections defined in Platform Hub can only be used to configure Platform Hub's version control settings and can't be used in spaces. ## Requested Permissions