From 8acfc51b11f32b4bc47af688ca7d25aa753faf8b Mon Sep 17 00:00:00 2001 From: Michael Bahr <1830132+bahrmichael@users.noreply.github.com> Date: Thu, 29 Aug 2024 18:57:18 +0200 Subject: [PATCH 1/2] docs(batches): explain credential migration (#607) Based on https://sourcegraph.slack.com/archives/C012V43N8E7/p1724928676289499?thread_ts=1723741990.954679&cid=C012V43N8E7 For https://linear.app/sourcegraph/issue/SRCH-946/how-do-we-handle-open-batch-changes-when-switching-authentication --- docs/batch-changes/configuring-credentials.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/batch-changes/configuring-credentials.mdx b/docs/batch-changes/configuring-credentials.mdx index 05c001b9e..e455ce5bc 100644 --- a/docs/batch-changes/configuring-credentials.mdx +++ b/docs/batch-changes/configuring-credentials.mdx @@ -201,6 +201,14 @@ GitHub apps follow the same concepts as [personal and global access tokens](#typ - GitHub apps can only be used with GitHub code hosts. - The forking mechanism (`fork:true`) is only supported if the GitHub app has access to all repositories of the installation, and if the origin repository and the fork are in the same organization that the GitHub app is installed to ([GitHub Docs](https://docs.github.com/en/rest/repos/forks?apiVersion=2022-11-28#create-a-fork)). +### Migrating from PATs to GitHub Apps + +You can migrate your credentials from PATs to GitHub Apps by deleting the PAT credential and creating a GitHub app credential. + +Batch Changes will look at the available credentials, and pick one that matches the targeted namespace (e.g. organization). + +You can continue to use existing batch changes without modifications. + ### Adding a GitHub app Adding a GitHub app is done through the Batch Changes section of your user settings: From 49f436a8cadc840fefeef07de8542ae22b0b2b00 Mon Sep 17 00:00:00 2001 From: Maedah Batool Date: Fri, 30 Aug 2024 10:08:34 -0700 Subject: [PATCH 2/2] Webhook GA docs --- docs/admin/config/webhooks/index.mdx | 2 +- docs/admin/config/webhooks/outgoing.mdx | 2 +- docs/code_monitoring/how-tos/index.mdx | 2 +- docs/code_monitoring/how-tos/webhook.mdx | 2 -- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/admin/config/webhooks/index.mdx b/docs/admin/config/webhooks/index.mdx index c95cab178..2cbc3aff4 100644 --- a/docs/admin/config/webhooks/index.mdx +++ b/docs/admin/config/webhooks/index.mdx @@ -1,4 +1,4 @@ # Webhooks - [Incoming webhooks](/admin/config/webhooks/incoming) -- [Outgoing webhooks](/admin/config/webhooks/outgoing) (Beta) +- [Outgoing webhooks](/admin/config/webhooks/outgoing) diff --git a/docs/admin/config/webhooks/outgoing.mdx b/docs/admin/config/webhooks/outgoing.mdx index 7fc77b2a4..71bb15842 100644 --- a/docs/admin/config/webhooks/outgoing.mdx +++ b/docs/admin/config/webhooks/outgoing.mdx @@ -1,6 +1,6 @@ # Outgoing webhooks - This feature is currently in beta and supported on Sourcegraph versions 5.0 or more. + This feature is supported on Sourcegraph versions 5.0 or more. Outgoing webhooks can be configured on a Sourcegraph instance in order to send Sourcegraph events to external tools and services. This allows for deeper integrations between Sourcegraph and other applications. diff --git a/docs/code_monitoring/how-tos/index.mdx b/docs/code_monitoring/how-tos/index.mdx index 5b480f0f7..dafa49f2a 100644 --- a/docs/code_monitoring/how-tos/index.mdx +++ b/docs/code_monitoring/how-tos/index.mdx @@ -2,4 +2,4 @@ * [Starting points](/code_monitoring/how-tos/starting_points) * [Setting up Slack notifications](/code_monitoring/how-tos/slack) -* [Setting up Webhook notifications](/code_monitoring/how-tos/webhook) (Beta) +* [Setting up Webhook notifications](/code_monitoring/how-tos/webhook) diff --git a/docs/code_monitoring/how-tos/webhook.mdx b/docs/code_monitoring/how-tos/webhook.mdx index 6f297905e..71a0c057d 100644 --- a/docs/code_monitoring/how-tos/webhook.mdx +++ b/docs/code_monitoring/how-tos/webhook.mdx @@ -1,7 +1,5 @@ # Setting up Webhook notifications -This feature is in beta. - Webhook notifications provide a way to execute custom responses to a code monitor notification. They are implemented as a POST request to a URL of your choice. The body of the request is defined by Sourcegraph, and contains all the information available about the cause of the notification.