diff --git a/public/docs/api-and-integration/github/github-connection-disconnect.png b/public/docs/api-and-integration/github/github-connection-disconnect.png index ac6081373f..a78c4ee00f 100644 Binary files a/public/docs/api-and-integration/github/github-connection-disconnect.png and b/public/docs/api-and-integration/github/github-connection-disconnect.png differ diff --git a/public/docs/api-and-integration/github/github-connection-edit.png b/public/docs/api-and-integration/github/github-connection-edit.png index 252aa21b1d..7ecb6000fa 100644 Binary files a/public/docs/api-and-integration/github/github-connection-edit.png and b/public/docs/api-and-integration/github/github-connection-edit.png differ diff --git a/public/docs/api-and-integration/github/github-connections-screen.png b/public/docs/api-and-integration/github/github-connections-screen.png index 9e2cc04d81..6203bf3ce4 100644 Binary files a/public/docs/api-and-integration/github/github-connections-screen.png and b/public/docs/api-and-integration/github/github-connections-screen.png differ diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 1fe4a45138..9dda23331f 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -1,9 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2024-03-14 -modDate: 2024-03-14 +modDate: 2024-09-17 title: GitHub integration description: Octopus Deploy GitHub integration +icon: fa-brands fa-github navOrder: 30 --- @@ -13,7 +14,7 @@ The Octopus Deploy GitHub App provides seamless integration between Octopus Depl The Octopus Deploy GitHub App is only supported on Octopus Cloud instances. ::: -To get started, go to the GitHub Connections page in the Library of your Octopus cloud instance, and follow the prompts. +To get started, go to the GitHub Connections page in the Deploy -> Manage section of your Octopus cloud instance, and follow the prompts. ## GitHub App Connections GitHub Connections is the recommended way to connect Octopus to your GitHub accounts (organizations or users). It provides seamless and secure connection via the Octopus GitHub App, without using personal access tokens. @@ -21,7 +22,9 @@ GitHub Connections is the recommended way to connect Octopus to your GitHub acco ### Connecting a GitHub account Before you can use an GitHub account in Octopus Deploy, you need to connect the account to the Space. +:::figure ![Screenshot of Octopus Deploy GitHub Connections screen showing OctopusPetShop organization connected and OctopusDeploy organization not connected](/docs/api-and-integration/github/github-connections-screen.png) +::: To connect a new account, select any currently disconnected account to go to the new connection screen where you can select the repositories and complete the connection. You can only connect each GitHub account once per Space. Once connected, the account will show at the top of the list with a Connected label. @@ -32,7 +35,9 @@ When you first open the GitHub connection page, you will be in view mode. This w You will not be able to save the connection unless you have at least 1 repository selected. To remove all of the repositories, disconnect the account completely using the Disconnect button in the overflow menu. +:::figure ![Screenshot of Octopus Deploy GitHub Connections screen showing OctopusPetShop connection with overflow menu expanded showing disconnect button](/docs/api-and-integration/github/github-connection-disconnect.png) +::: ### Selecting repositories on the GitHub Connection Each GitHub Connection defines its own set of repositories (this is on top of the list of repositories configured on the installation in GitHub). @@ -42,7 +47,9 @@ GitHub accounts can only have a single GitHub App installation, so this installa #### If you can't see a repository Octopus can only see repositories that are available to the app installation and the current user. If you can't see a repository that you expect to see on this screen, it may not be accessible to either you or the installation. To configure more repositories on a connection, follow the link at the bottom of the repository selection screen to configure more repositories on GitHub. +:::figure ![Screenshot of Octopus Deploy GitHub Connections screen for OctopusPetShow in edit mode showing PetShop and ProductAPI repositories selected and UserAPI deselected. Configure repository access in the Octopus Deploy app on GitHub link is shown at the bottom of the page](/docs/api-and-integration/github/github-connection-edit.png) +::: #### Only repository administrators can connect repositories To connect a repository, you must be an administrator of the repository on GitHub. If you're not an administrator (but can view the repository), you will still see the repository in the list, but will not be able to select it. @@ -58,3 +65,7 @@ Installing and authorizing are both GitHub concepts. If you want to find out mor - [GitHub Apps documentation](https://docs.github.com/en/apps/using-github-apps/about-using-github-apps) - [Installing GitHub apps documentation](https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-a-third-party) - [Authorizing GitHub apps documentation](https://docs.github.com/en/apps/using-github-apps/authorizing-github-apps) + +## Older versions + +- Prior to version 2024.3.12703 when the new UI navigation was introduced, the GitHub Connections page is located in the Library section of Octopus. \ No newline at end of file