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: description for (1) Add deploy Key

This commit is contained in:
peaceiris 2019-05-26 00:56:03 +09:00
parent 6009c110fc
commit 9bfcfe68ee
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -18,12 +18,20 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
### (1) Add deploy Key
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.
3. Add your public key within "Allow write access" option.
4. Go to "Settings > Secrets" of repository.
5. Add your private key as `ACTIONS_DEPLOY_KEY`
Generate deploy key with the following command.
```sh
ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N ""
# You will get 2 files:
# gh-pages.pub (public key)
# gh-pages (private key)
```
Next, Go to **Repository Settings**
- Go to **Deploy Keys** and add your public key with the "Allow write access"
- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY`
### (2) Create `main.workflow`