status-im
/
actions-gh-pages
mirror of https://github.com/status-im/actions-gh-pages.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

enhance: explanation for (1) Add deploy Key

This commit is contained in:
peaceiris 2019-05-22 07:25:01 +09:00
parent 036c4a14e0
commit 7c2aa28333
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -19,10 +19,11 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
### (1) Add deploy Key ### (1) Add deploy Key
1. Generate deploy key `ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N ""` 1. Generate deploy key `ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N ""`
- You will get 2 files: `gh-pages.pub` (public key) and `gh-pages` (private key)
2. Go to "Settings > Deploy Keys" of repository. 2. Go to "Settings > Deploy Keys" of repository.
3. Add your public key within "Allow write access" option. 3. Add your public key within "Allow write access" option.
4. Go to "Settings > Secrets" of repository. 4. Go to "Settings > Secrets" of repository.
5. Add your private deploy key as `ACTIONS_DEPLOY_KEY` 5. Add your private key as `ACTIONS_DEPLOY_KEY`
### (2) Create `main.workflow` ### (2) Create `main.workflow`