From d3f6031561c5decb3e035e1e181aff09231a328e Mon Sep 17 00:00:00 2001 From: Brandon Philips Date: Wed, 20 Nov 2024 10:44:06 -0800 Subject: [PATCH] README: add warning about internet access gitsign differs from GPG in that it requires an internet access on every commit. This breaks the git model of working offline. So, probably worth calling out. Signed-off-by: Brandon Philips --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 06c90806..6339f2fd 100644 --- a/README.md +++ b/README.md @@ -32,19 +32,27 @@ Single Repository: ```sh cd /path/to/my/repository -git config --local commit.gpgsign true # Sign all commits -git config --local tag.gpgsign true # Sign all tags git config --local gpg.x509.program gitsign # Use gitsign for signing git config --local gpg.format x509 # gitsign expects x509 args + +# Warning: Setting this will make git commit/tag reliant on internet. +# Alternatively, don't use these settings and add the -S flag instead. +git config --local commit.gpgsign true # Sign all commits +git config --local tag.gpgsign true # Sign all tags + ``` All respositories: ```sh -git config --global commit.gpgsign true # Sign all commits -git config --global tag.gpgsign true # Sign all tags git config --global gpg.x509.program gitsign # Use gitsign for signing git config --global gpg.format x509 # gitsign expects x509 args + + +# Warning: Setting this will make git commit/tag reliant on internet. +# Alternatively, don't use these settings and add the -S flag instead. +git config --global commit.gpgsign true # Sign all commits +git config --global tag.gpgsign true # Sign all tags ``` To learn more about these options, see