File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed
Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change @@ -57,6 +57,35 @@ steps:
5757 git-config-scope: global # Works anywhere in workflow
5858` ` `
5959
60+ # # What Gets Configured
61+
62+ The action automatically configures Git for SSH signing by setting these config values :
63+
64+ | Config Key | Value | Effect |
65+ | ---------------------------- | --------------------------- | ----------------------------------------------- |
66+ | `user.name` | From `git-user-name` input | Sets commit author name |
67+ | `user.email` | From `git-user-email` input | Sets commit author email |
68+ | `gpg.format` | `ssh` | Tells Git to use SSH signing instead of GPG |
69+ | `user.signingkey` | Path to public key | Specifies which SSH key to use for signing |
70+ | `commit.gpgsign` | `true` (default) | **Automatically signs all commits** |
71+ | `tag.gpgsign` | `true` (default) | **Automatically signs all tags** |
72+ | `push.gpgsign` | `if-asked` (default) | Signs pushes only if requested by remote server |
73+ | `gpg.ssh.allowedSignersFile` | (optional) | Enables local verification of signatures |
74+
75+ **Important**: Once configured, you **don't need to add signing flags** to git commands:
76+
77+ ` ` ` bash
78+ # These commands will be automatically signed:
79+ git commit -m "feat: add new feature"
80+ git tag v1.0.0
81+
82+ # No need for:
83+ # git commit -S -m "..." ❌
84+ # git tag -s v1.0.0 ❌
85+ ` ` `
86+
87+ Automatic signing happens because `commit.gpgsign` and `tag.gpgsign` are set to `true`.
88+
6089# # Setup (5 Minutes)
6190
6291# ## 1. Generate SSH Key
You can’t perform that action at this time.
0 commit comments