Files
probot.github.io/_apps/gpg.md
2017-09-23 16:38:01 -05:00

2.6 KiB

title, description, slug, screenshots, authors, repository
title description slug screenshots authors repository
GPG Enforce GPG signatures on Pull Requests probot-gpg
https://user-images.githubusercontent.com/235875/30776187-bed103a8-a067-11e7-9ecc-5540c03114e1.png
https://user-images.githubusercontent.com/235875/30776885-3ab13158-a074-11e7-95df-8b6eb7d6b795.png
jarrodldavis
jarrodldavis/probot-gpg

Usage

Configure this app on your organizations and repositories. Be sure to enable required status checks if you want to enforce GPG signatures on all pull requests.

How it works

Git supports signing commits with GPG keys to verify commit authorship beyond the easy-to-forge author field.

GitHub supports verifying GPG signatures on commits and has an excellent series of help articles for creating a GPG key, using it with git locally, and linking it to your GitHub account.

After installation, this app checks all commits of new (or newly updated) pull requests for valid GPG signatures according to the GitHub API. Note that for the status check to pass, every contributor of a pull request must:

  • set up a GPG key on their local machine
  • sign all of their commits in the pull request with that key
  • link that key with their GitHub account

GPG Status Check Success

Otherwise, the app will set the status to failed.

GPG Status Check Failed

Further reading