From bbd5513ed5e1a794add6cfc57776b346873803df Mon Sep 17 00:00:00 2001 From: Ror <47309835+rorcores@users.noreply.github.com> Date: Thu, 18 Nov 2021 02:58:33 -0800 Subject: [PATCH] Better explain in the README how to set up keys in repositories (#96) --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 87c63a9..7725d64 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,14 @@ GitHub Actions only have access to the repository they run for. So, in order to ## Usage -1. Create an SSH key with sufficient access privileges. For security reasons, don't use your personal SSH key but set up a dedicated one for use in GitHub Actions. See below for a few hints if you are unsure about this step. +1. Generate a new SSH key with sufficient access privileges. For security reasons, don't use your personal SSH key but set up a dedicated one for use in GitHub Actions. See below for a few hints if you are unsure about this step. 2. Make sure you don't have a passphrase set on the private key. -3. In your repository, go to the *Settings > Secrets* menu and create a new secret. In this example, we'll call it `SSH_PRIVATE_KEY`. Put the contents of the *private* SSH key file into the contents field.
- This key should start with `-----BEGIN ... PRIVATE KEY-----`, consist of many lines and ends with `-----END ... PRIVATE KEY-----`. -4. In your workflow definition file, add the following step. Preferably this would be rather on top, near the `actions/checkout@v2` line. +3. Add the public SSH key to the private repository you are pulling from during the Github Action as a 'Deploy Key'. +4. Add the private SSH key to the repository triggering the Github Action: + * In your repository, go to the *Settings > Secrets* menu and create a new secret. In this example, we'll call it `SSH_PRIVATE_KEY`. + * Put the contents of the *private* SSH key file into the contents field.
+ * This key should start with `-----BEGIN ... PRIVATE KEY-----`, consist of many lines and ends with `-----END ... PRIVATE KEY-----`. +5. In your workflow definition file, add the following step. Preferably this would be rather on top, near the `actions/checkout@v2` line. ```yaml # .github/workflows/my-workflow.yml