Skip to content

Commit

Permalink
Add context to README
Browse files Browse the repository at this point in the history
  • Loading branch information
frankywahl committed Aug 27, 2022
1 parent db00bcb commit 1ac32c9
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This is a little script that allows you to use GitHub's API to download the public keys of GitHub collaborators and save them to a file for use with Git's SSH signing features.

## Installation

You can download the binary from the [Releases](https://github.com/frankywahl/allowedSignersFile/releases) or use it directly with go, as described below

## Example Usage

```bash
Expand All @@ -13,7 +17,8 @@ Note: we can use the `--use-contributors` as a means to get all the contributors

## Requirements

* [go](https://go.dev/)
* [GITHUB_API_TOKEN](https://github.com/settings/tokens) To use the Github API
* [go](https://go.dev/) (if you want to run if from source)

## Limitations

Expand All @@ -39,4 +44,9 @@ https://calebhearth.com/sign-git-with-ssh

# SSH Signing Github Support

Github has supported SSH Signing since [August 2022](https://github.blog/changelog/2022-08-23-ssh-commit-verification-now-supported/)
That being said SSH Commit signing was part of [Git](https://git-scm.com/) [beforehand](https://lore.kernel.org/git/[email protected]/)

If commits were signed before the release on Github, they will still appear as verified provided the SSH public key was still uploaded as a [Signing Key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-ssh-key)

https://github.com/community/community/discussions/7744#discussioncomment-2564268

0 comments on commit 1ac32c9

Please sign in to comment.