adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
James Ives 2020-10-10 15:35:25 -04:00
parent 5b08472e0a
commit fbc5cb96d6
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -178,7 +178,7 @@ The action will export an environment variable called `DEPLOYMENT_STATUS` that y
If you'd prefer to use an SSH deploy key as opposed to a token you must first generate a new SSH key by running the following terminal command, replacing the email with one connected to your GitHub account.
```bash
ssh-keygen -t rsa -b 4096 -C "youremailhere@example.com" -N ""
ssh-keygen -t rsa -m pem -b 4096 -C "youremailhere@example.com" -N ""
```
Once you've generated the key pair you must add the contents of the public key within your repository's [deploy keys menu](https://developer.github.com/v3/guides/managing-deploy-keys/). You can find this option by going to `Settings > Deploy Keys`, you can name the public key whatever you want, but you **do** need to give it write access. Afterwards add the contents of the private key to the `Settings > Secrets` menu as `DEPLOY_KEY`.
@ -187,7 +187,7 @@ With this configured you must add the `ssh-agent` step to your workflow and set
```yml
- name: Install SSH Client 🔑
uses: webfactory/ssh-agent@v0.2.0
uses: webfactory/ssh-agent@v0.4.1
with:
ssh-private-key: ${{ secrets.DEPLOY_KEY }}