nhs-england-tools / repository-template

🛠️ 📚💡 This is a detailed and carefully made template for your GitHub projects. It's based on the wide knowledge and practical experience of the engineering community within NHS England. The template includes helpful suggestions, standards and practices - it's something you should consider using for all your repositories.
MIT License
30 stars 12 forks source link

Add a guide on how to set up Git commit signing #92

Closed stefaniuk closed 1 year ago

stefaniuk commented 1 year ago

Description

Signing Git commits is a crucial practice. Therefore, we're adding a guide on how to set it up. This ensures the correct web of trust has been established for the distributed version control management.

Type of changes

Checklist


Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

regularfry commented 1 year ago

Would we be happy with SSH keys instead of GPG keys? SSH key signing is much simpler to set up - I'm guessing that most would already have an SSH key attached to their github account that would work, and while GPG offers revocation, in practice we get all the same benefits by just rotating the SSH key.

stefaniuk commented 1 year ago

@regularfry Good point, thanks! I've added a note indicating that both methods, GPG and SSH, are acceptable. The former is preferred because it has been around for many years, whereas the latter was introduced to Git in November 2021 and was only adopted by GitHub a year ago.

stefaniuk commented 1 year ago

@regularfry thanks for feedback and review, merging...