Skip to content

Commit 9bfcfe6

Browse files
committed
enhance: description for (1) Add deploy Key
1 parent 6009c11 commit 9bfcfe6

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,20 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
1818

1919
### (1) Add deploy Key
2020

21-
1. Generate deploy key `ssh-keygen -t rsa -b 4096 -C "[email protected]" -f gh-pages -N ""`
22-
- You will get 2 files: `gh-pages.pub` (public key) and `gh-pages` (private key)
23-
2. Go to "Settings > Deploy Keys" of repository.
24-
3. Add your public key within "Allow write access" option.
25-
4. Go to "Settings > Secrets" of repository.
26-
5. Add your private key as `ACTIONS_DEPLOY_KEY`
21+
Generate deploy key with the following command.
22+
23+
```sh
24+
ssh-keygen -t rsa -b 4096 -C "[email protected]" -f gh-pages -N ""
25+
26+
# You will get 2 files:
27+
# gh-pages.pub (public key)
28+
# gh-pages (private key)
29+
```
30+
31+
Next, Go to **Repository Settings**
32+
33+
- Go to **Deploy Keys** and add your public key with the "Allow write access"
34+
- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY`
2735

2836
### (2) Create `main.workflow`
2937

0 commit comments

Comments
 (0)