Skip to content

feat: update docs for commit signing #1021

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

Merged
merged 5 commits into from
Mar 25, 2025
Merged

feat: update docs for commit signing #1021

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc30d67
feat: update docs for commit signing
bahrmichael Mar 10, 2025
f083e38
add pictures
bahrmichael Mar 13, 2025
5a65ffc
Merge branch 'main' into bahrmichael/commit-signing
bahrmichael Mar 13, 2025
a2e3c55
include fine-grained access token
bahrmichael Mar 19, 2025
82d76cb
Add feedback
MaedahBatool Mar 25, 2025
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
26 changes: 25 additions & 1 deletion docs/admin/config/batch_changes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,31 @@ GitHub | API call | ✓ | ✓ |
GitLab | Changeset property | ✓ | ✓ |
Gerrit | API call | ✗ | ✓ | Requires ["delete own changes" permission](https://gerrit-review.googlesource.com/Documentation/access-control.html#category_delete_own_changes) at minimum

## Commit signing for GitHub
## Commit signing

Batch Changes supports Commit Signing with GitHub Apps since version 5.1 and with SSH Keys since version 6.2.

### Commit signing with SSH Keys (GitLab and GitHub)

<Callout type="note"> This feature is supported only in Sourcegraph versions 6.2 or more.</Callout>
Copy link
Contributor

@derek-feriancek-sg derek-feriancek-sg Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: How about "or later" instead of "or more"?

Copy link
Contributor

@derek-feriancek-sg derek-feriancek-sg Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, after finishing reading this diff I see we have "or more" in other parts of the docs as well. I'm curious what Maedah's stance is

Copy link
Contributor Author

@bahrmichael bahrmichael Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MaedahBatool do we have a standard here?

Copy link
Contributor

@MaedahBatool MaedahBatool Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @bahrmichael we have the following formats:

  • v6.2 or more
  • v6.2+


Commit signing with SSH keys can only be used in combination with a personal access token.

Sourcegraph can be configured to sign commits using SSH keys, both with user and site admin credentials.

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.

If you already have a credential for the given code host, you have to remove it first.

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.

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".

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.

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.

### Commit signing with GitHub Apps

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

Expand Down