Skip to content

Updating public docs to reflect GitHub Connections in Platform Hub capabilities and limitations #3062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
felixi-octopus wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

Updating public docs to reflect GitHub Connections in Platform Hub capabilities and limitations #3062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/pages/docs/platform-hub/templates/process-templates/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

Expand All @@ -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:

```text
```powershell
Octopus.ProcessTemplate.Action[StepName].Output.PropertyName
```

Expand Down
2 changes: 2 additions & 0 deletions src/pages/docs/projects/version-control/github/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [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

There are specific GitHub permissions that the Octopus GitHub App requests in order to perform it's tasks.
Expand Down
Loading