[docs] Add note of checking the SSH key #5762
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5762 +/- ##
==========================================
- Coverage 27.08% 27.07% -0.01%
==========================================
Files 504 504
Lines 53178 53178
==========================================
- Hits 14401 14397 -4
- Misses 37703 37706 +3
- Partials 1074 1075 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ffjlabo
reviewed
Apr 21, 2025
| @@ -60,3 +60,5 @@ For the full list of available commands, please see the Makefile at the root of | |||
| ``` console | |||
| make run/piped CONFIG_FILE=piped-config.yaml | |||
| ``` | |||
|
|
|||
| Note: If you have a problem with accessing the example repository, please follow [this guide](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) to register the SSH key or try specifying `remote: https://github.com/pipe-cd/examples.git` instead in the above `piped-config.yaml`. | |||
There was a problem hiding this comment.
[imo] How about adding the explanation like Prepare for connecting to github with ssh on Prerequisites ?
It might be good for developers to know it before trying it.
There was a problem hiding this comment.
@ffjlabo
I got your point, and it also seems great.
I think just using HTTPS is enough for some cases, and SSH is not mandatory.
There was a problem hiding this comment.
@t-kikuc
I got it. It certainly doesn't have to be ssh 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does:
as title
Why we need it:
To help troubleshooting.
The app suggestion on UI won't work if a user hasn't set up an SSH key for cloning
[email protected]:pipe-cd/examples.git.Which issue(s) this PR fixes:
Does this PR introduce a user-facing change?: