mirror of
https://github.com/peaceiris/actions-gh-pages.git
synced 2026-10-03 10:01:37 +00:00
enhance: description for (1) Add deploy Key
This commit is contained in:
1 parent
6009c110fc
commit
9bfcfe68ee
1 file changed
+14
-6
@@ -18,12 +18,20 @@ 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 ""`
|
Generate deploy key with the following command.
|
||||||
- You will get 2 files: `gh-pages.pub` (public key) and `gh-pages` (private key)
|
|
||||||
2. Go to "Settings > Deploy Keys" of repository.
|
```sh
|
||||||
3. Add your public key within "Allow write access" option.
|
ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N ""
|
||||||
4. Go to "Settings > Secrets" of repository.
|
|
||||||
5. Add your private key as `ACTIONS_DEPLOY_KEY`
|
# 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`
|
### (2) Create `main.workflow`
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user