docs: note gitPrivateKey passphrase-less requirement #15871
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Docs update that clarifies using
gitPrivateKey
that's been passphrase protected is not possible (in most cases).Context
Users trying to add a key that's protected with a passphrase will most likely see
Inappropriate ioctl for device
error.Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: