"Commits must have verified signatures." isn't helpful

[jsoref]

Select Topic Area

Product Feedback

Body

Merging is blocked - Commits must have verified signatures.

• README check-spelling-sandbox/fluffy-spork-ideal-eureka#1
  

  ⚠️ Merging is blocked
  Commits must have verified signatures.

Great. A red box. What is a normal person supposed to do?

This box should provide a link to a page that explains how a normal person can fix this problem.

Signing paths

GPG Signing

The first hit for github+docs+signed+commits is:

• https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits
  it's lousy for various reasons:
  1. It doesn't explain how to set up ssh signing.
  2. I don't think it explains how to set up gpg keys.
  3. It doesn't explain how to rewrite your commits.

The second set of hits is https://docs.github.com/en/authentication/managing-commit-signature-verification

• https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key at least explains how to generate a key (yay!)
• https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key explains how to set up some of this stuff (yay!)
• https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account explains how to tell github (yay!)
• https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits still doesn't explain how to fix existing commits (sigh)

Collectively, this absolutely isn't terrible (but it definitely isn't great).

SSH Signing

There doesn't appear to be any content on https://docs.github.com about ssh based verification.

I believe that my configuration is roughly:

1. Add config to ~/.gitconfig:

   [user]
           signingkey = ~/.ssh/id_rsa.pub
   
   [gpg]
           format = ssh

2. visiting https://github.com/settings/keys and adding the ssh key for signing.

This could be documented, but isn't. I'm leaving it here. (Technically there are various considerations for which kind of key to use, roughly equivalent to the choices for gpg, but, practically a user is likely to have one key, generated by gh as part of onboarding and a short bit of prose can help users manage this.)

S/MIME Signing

Ok, the docs on github.com basically say "you should only do this if you're in an org that already does this" which implies that the org will have instructions for how to set this up. That's reasonable.

TODO

Please fix the red box to point to a docs page that gives users simple pointers:

1. Set up signing
   1. Creating signing key
   2. Configure git to use signing key
   3. Tell github about signing key
2. Rewrite commits w/ signing key

Preferably the Set up signing landing page should offer both gpg and ssh (I'd argue it should favor ssh as they're really much easier to deal w/).

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐