From 3474dda9215155c2a7a8676d59cd7609013f8457 Mon Sep 17 00:00:00 2001
From: Peter Evans <peter-evans@users.noreply.github.com>
Date: Fri, 3 Apr 2020 17:26:11 +0900
Subject: [PATCH] Update documentation
---
docs/concepts-guidelines.md | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/docs/concepts-guidelines.md b/docs/concepts-guidelines.md
index dd40f90..46b1ad1 100644
--- a/docs/concepts-guidelines.md
+++ b/docs/concepts-guidelines.md
@@ -162,16 +162,13 @@ How to use SSH (deploy keys) with create-pull-request action:
1. [Create a new SSH key pair](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key) for your repository. Do not set a passphrase.
2. Copy the contents of the public key (.pub file) to a new repository [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) and check the box to "Allow write access."
3. Add a secret to the repository containing the entire contents of the private key.
-4. As shown in the example steps below, use the [`webfactory/ssh-agent`](https://github.com/webfactory/ssh-agent) action to install the private key and clone your repository. Remember to checkout the `base` of your pull request if it's not the default branch, e.g. `git checkout my-branch`.
+4. As shown in the example below, configure `actions/checkout` to use the deploy key you have created.
```yml
steps:
- - uses: webfactory/ssh-agent@v0.2.0
+ - uses: actions/checkout@v2
with:
- ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
-
- - name: Checkout via SSH
- run: git clone git@github.com:peter-evans/create-pull-request.git .
+ ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
# Make changes to pull request here