Skip to content

Commit dc30d67

Browse files
committed
feat: update docs for commit signing
1 parent e5ad862 commit dc30d67

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/admin/config/batch_changes.mdx

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,31 @@ GitHub | API call | ✓ | ✓ |
180180
GitLab | Changeset property | ✓ | ✓ |
181181
Gerrit | API call | ✗ | ✓ | Requires ["delete own changes" permission](https://gerrit-review.googlesource.com/Documentation/access-control.html#category_delete_own_changes) at minimum
182182

183-
## Commit signing for GitHub
183+
## Commit signing
184+
185+
Batch Changes supports Commit Signing with GitHub Apps since version 5.1 and with SSH Keys since version 6.2.
186+
187+
### Commit signing with SSH Keys (GitLab and GitHub)
188+
189+
<Callout type="note"> This feature is supported only in Sourcegraph versions 6.2 or more.</Callout>
190+
191+
Commit signing with SSH keys can only be used in combination with a personal access token.
192+
193+
Sourcegraph can be configured to sign commits using SSH keys, both with user and site admin credentials.
194+
195+
To enable **commit signing for your Batch Changes user**, navigate to **Settings > Batch Changes** and click on "Add credentials" for a GitHub or GitLab code host.
196+
197+
If you already have a credential for the given code host, you have to remove it first.
198+
199+
Enter your personal access token, and check the box "Sign commits on this code host". This will add an additional step to the setup flow. Click on "Add credential" and wait for Batch Changes to verify the access token.
200+
201+
Once the credential is added, you can continue to the "Get Commit Signing Key" step to get the public SSH key that Batch Changes will use to sign commits. You can view the public key at any time by clicking on "View Credentials".
202+
203+
Add this public SSH key to your [GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) or [GitLab](https://docs.gitlab.com/user/ssh/#add-an-ssh-key-to-your-gitlab-account) account.
204+
205+
To enable **commit signing as a site admin**, navigate to **Site Admin > Section: Batch Changes > Settings** and click on "Add credentials" for a GitHub or GitLab code host. The rest of the setup is the same as above.
206+
207+
### Commit signing with GitHub Apps
184208

185209
<Callout type="note"> The feature is currently in Beta stage and supported on Sourcegraph versions 5.1 or more.</Callout>
186210

0 commit comments

Comments
 (0)