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-01-19 13:27:17 -05:00 committed by GitHub
parent 97e26d6a86
commit 64b4c5c7dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -89,7 +89,7 @@ If you'd prefer to use an SSH deploy key as opposed to a token you must first ge
ssh-keygen -t rsa -b 4096 -C "youremailhere@example.com" -N "" ssh-keygen -t rsa -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 repositories [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. Afterwards add the contents of the private key to the `Settings > Secrets` menu as `DEPLOY_KEY`. Once you've generated the key pair you must add the contents of the public key within your repositories [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`.
With this configured you must add the `ssh-agent` step to your workflow and set `SSH` to `true` within the deploy action. With this configured you must add the `ssh-agent` step to your workflow and set `SSH` to `true` within the deploy action.
@ -225,4 +225,4 @@ If you use a [container](https://help.github.com/en/actions/automating-your-work
- name: Deploy - name: Deploy
uses: JamesIves/github-pages-deploy-action@releases/v3 uses: JamesIves/github-pages-deploy-action@releases/v3
``` ```