docs icon indicating copy to clipboard operation
docs copied to clipboard

Remove the public specification for OpenSSH key commit signature

Open bobsaintcool opened this issue 2 years ago • 5 comments

Why:

Closes https://github.com/github/docs/issues/20243

What's being changed (if available, include any code snippets, screenshots, or gifs):

The specification of signature of Git commit with an OpenSSH key mentioned that one used the public part to perform the signature. However, this is the private part that is used to sign and the public part used for other to verify the signature.

Check off the following:

  • [ ] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

bobsaintcool avatar Aug 28 '22 21:08 bobsaintcool

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Aug 28 '22 21:08 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
authentication/managing-commit-signature-verification/about-commit-signature-verification.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Aug 28 '22 22:08 github-actions[bot]

@bobsaintcool Thanks for opening a PR and linking it to your issue! ✨

I'll get this triaged for review! ⚡

cmwilson21 avatar Aug 29 '22 14:08 cmwilson21

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Oct 12 '22 21:10 github-actions[bot]

Maybe it will be nice to have a link to the Git documentation about user.signingKey this could remove some confusion.

You can use SSH to [sign commits with an SSH key](https://git-scm.com/docs/git-config#Documentation/git-config.txt-usersigningKey) that you generate yourself.

bobsaintcool avatar Oct 13 '22 16:10 bobsaintcool

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Oct 20 '22 21:10 github-actions[bot]

Thanks for the polish! :heart:

bobsaintcool avatar Oct 20 '22 22:10 bobsaintcool

Why:

Closes #20243

What's being changed (if available, include any code snippets, screenshots, or gifs):

The specification of signature of Git commit with an OpenSSH key mentioned that one used the public part to perform the signature. However, this is the private part that is used to sign and the public part used for other to verify the signature.

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

akasyagroup avatar Oct 24 '22 11:10 akasyagroup