10000 docs: explicitly recommend SSH over HTTPS and add GitHub documentatio… · drivecore/mycoder@312f739 · GitHub
[go: up one dir, main page]

Skip to content

Commit 312f739

Browse files
committed
docs: explicitly recommend SSH over HTTPS and add GitHub documentation link
1 parent 3d5bb31 commit 312f739

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

packages/docs/docs/usage/github-action.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ This clearly identifies commits made automatically by MyCoder.
160160

161161
### SSH Authentication
162162

163+
While SSH authentication is generally recommended over HTTPS for most Git operations due to its security benefits, in automated environments like GitHub Actions, special considerations apply:
164+
163165
When using GitHub Actions with SSH authentication:
164166

165167
1. **Avoid SSH Keys with Passphrases**: For automated environments like GitHub Actions, use SSH keys without passphrases or use alternative authentication methods.

packages/docs/docs/usage/github-mode.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ If your team uses a complex GitHub workflow (e.g., with code owners, required re
142142

143143
### SSH Passphrase Best Practices
144144

145+
MyCoder recommends using SSH authentication over HTTPS whenever possible, as SSH provides better security and doesn't require entering username/password credentials for each operation. However, if you use SSH keys with passphrases, proper configuration is necessary to prevent interruptions during automated operations.
146+
147+
For detailed instructions, see [GitHub's official documentation on connecting with SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
148+
145149
When using GitHub mode with SSH authentication, it's important to properly manage SSH key passphrases to ensure automation works smoothly:
146150

147151
1. **Use SSH Agent**: Configure ssh-agent to remember your passphrase, so you don't need to enter it repeatedly:

0 commit comments

Comments
 (0)
0