diff --git a/public/docs/i/x/api-and-integration/github/github-connection-edit.png b/public/docs/i/x/api-and-integration/github/github-connection-edit.png index eaa23062cd..5304e4cd42 100644 Binary files a/public/docs/i/x/api-and-integration/github/github-connection-edit.png and b/public/docs/i/x/api-and-integration/github/github-connection-edit.png differ diff --git a/public/docs/i/x/api-and-integration/github/github-connections-screen.png b/public/docs/i/x/api-and-integration/github/github-connections-screen.png index 95ddec2b00..9ddd04517f 100644 Binary files a/public/docs/i/x/api-and-integration/github/github-connections-screen.png and b/public/docs/i/x/api-and-integration/github/github-connections-screen.png differ diff --git a/public/docs/img/api-and-integration/github/github-connection-edit.png b/public/docs/img/api-and-integration/github/github-connection-edit.png index 7ecb6000fa..5304e4cd42 100644 Binary files a/public/docs/img/api-and-integration/github/github-connection-edit.png and b/public/docs/img/api-and-integration/github/github-connection-edit.png differ diff --git a/public/docs/img/api-and-integration/github/github-connections-screen.png b/public/docs/img/api-and-integration/github/github-connections-screen.png index 6203bf3ce4..9ddd04517f 100644 Binary files a/public/docs/img/api-and-integration/github/github-connections-screen.png and b/public/docs/img/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 a00950f439..131be2c8f4 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2024-03-14 -modDate: 2026-04-13 +modDate: 2026-04-16 title: GitHub integration description: Octopus Deploy GitHub integration icon: fa-brands fa-github @@ -60,6 +60,17 @@ Octopus can only see repositories that are available to the app installation and 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. +### Recovering a GitHub App connection + +Octopus can help you recover your GitHub App connection automatically if you lose the connection in the following cases: + +- Disconnecting the GitHub App +- The registration is broken (for example, your instance URL was changed) +- The app was uninstalled on GitHub +- The app was suspended on GitHub + +Simply follow the on-screen prompts to reconnect the account and select the same repositories as before. + ## Using GitHub App Connections 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). @@ -68,7 +79,7 @@ You can also define GitHub Connections in [Platform Hub](/docs/platform-hub). Gi ## Requested Permissions -There are specific GitHub permissions that the Octopus GitHub App requests in order to perform it's tasks. +There are specific GitHub permissions that the Octopus GitHub App requests in order to perform its tasks. - **Repository Permissions** - **Contents: Read and Write** Allows Octopus to access the files in the approved repositories for usage such as [Config As Code](https://octopus.com/docs/projects/version-control) projects, [Git Resources in deployments](https://octopus.com/blog/git-resources-in-deployments) or during some steps such as [Argo CD](https://octopus.com/docs/argo-cd). @@ -85,7 +96,7 @@ The Octopus Deploy GitHub App can be used with the GitHub's allow list feature. :::div{.hint} **Note:** -In order to use Octopus Deploy with GitHub allow lists, the IP address of your Octopus Deploy instance and any workers that require GitHub access will also need to be added. If you are using a Octopus Cloud instance of Octopus Deploy you can obtain your [static IP](/docs/octopus-cloud/static-ip) via the Control Center. +In order to use Octopus Deploy with GitHub allow lists, the IP address of your Octopus Deploy instance and any workers that require GitHub access will also need to be added. If you are using an Octopus Cloud instance of Octopus Deploy you can obtain your [static IP](/docs/octopus-cloud/static-ip) via the Control Center. ::: Due to a limitation in the way that GitHub supports inheritance of IP addresses when performing actions on behalf of a user, the IP address for the GitHub App needs to be configured manually and cannot be inherited from the app settings. For more information please refer to [GitHub's Documentation](https://docs.github.com/en/enterprise-cloud@latest/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app#about-ip-address-allow-lists-for-github-apps)