Add instructions for setting up git signing #4018
Conversation
| @@ -13,7 +13,7 @@ | |||
| "test": "npm run test:prefixed-links && npm run test:internal-links && npm run test:html-validation && npm run test:spelling", | |||
| "test:html-validation": "html-validate _site/**/*.html", | |||
| "test:internal-links": "node check-links.js", | |||
| "test:prefixed-links": "! (grep -Erl \"\\(/|href=['\\\"]/\" pages && echo \"ERROR: Internal links must use {% page \"page name\" %} to work correctly with Cloud.gov Pages previews. Fix the above pages.\")", | |||
| "test:prefixed-links": "! (grep -Erl \"\\]\\(/|href=['\\\"]/\" pages && echo \"ERROR: Internal links must use {% page \"page name\" %} to work correctly with Cloud.gov Pages previews. Fix the above pages.\")", | |||
There was a problem hiding this comment.
This change tightens up the regex a little bit to look for ](/ to find relative links that are not using the {% page %} shortcode. The need comes from the case where we need to put file paths inside parentheses. For example:
Put the file in the magic directory (/Users/yourusername/.ssh)
The current regex flags that line as an invalid link, but it is, of course, not a link at all. Adding the preceding closing square bracket to the regex allows this line to pass while continuing to enforce the intent of the check.
The repo should reference the org where allstar is running from
| [Allstar]({%link "https://github.com/GSA-TTS/.allstar" %}). If your team's | ||
| repository is managed by Allstar, it will _require_ commit signing. | ||
|
|
||
| We also strongly recommend using a password manager to manager your signing |
There was a problem hiding this comment.
I followed the KeyPass instructions and confirmed that git is signing my commits and GitHub marks them as verified! The manual steps look good to me although I didn't walk through them.
I added a couple of small and non-blocking notes on content. It looks good in terms of technical accuracy and overall flow! I'm setting this review at "Comment" pending another readability review.
| [Allstar]({%link "https://github.com/GSA-TTS/.allstar" %}). If your team's | ||
| repository is managed by Allstar, it will _require_ commit signing. | ||
|
|
||
| We also strongly recommend using a password manager to manager your signing |
There was a problem hiding this comment.
It might be worth linking to the password manager page of the handbook here: https://handbook.tts.gsa.gov/general-information-and-resources/tech-policies/password-requirements/#1-use-a-password-manager
| necessary. Then enter this command in your terminal: | ||
|
|
||
| ```sh | ||
| echo "your-email@gsa.gov [PASTE]" >> ~/.gitsigners |
There was a problem hiding this comment.
It might be pilot error but I didn't notice I also needed to update the your-email@gsa.gov part in this line the first time through, since the [PASTE] right next to it got my attention.
Changes proposed in this pull request: