release v1.1.0 (#4)
* change: use GITHUB_TOKEN instead of ACTIONS_DEPLOY_KEY * enhance: entrypoint.sh * update: readme for v1.1.0 (Fixes #3) * remove: images/patreon.jpg
This commit is contained in:
parent
1f78e2b780
commit
5af287f677
31
README.md
31
README.md
|
@ -16,24 +16,7 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
|
|||
|
||||
## Getting started
|
||||
|
||||
### (1) Add 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`
|
||||
### Create `.github/main.workflow`
|
||||
|
||||
An example with Hugo action.
|
||||
|
||||
|
@ -60,18 +43,18 @@ action "is-not-branch-deleted" {
|
|||
|
||||
action "build" {
|
||||
needs = ["is-branch-master", "is-not-branch-deleted"]
|
||||
uses = "peaceiris/actions-hugo@v0.55.6"
|
||||
uses = "peaceiris/actions-hugo@v0.56.3"
|
||||
args = ["--gc", "--minify", "--cleanDestinationDir"]
|
||||
}
|
||||
|
||||
action "deploy" {
|
||||
needs = "build"
|
||||
uses = "peaceiris/actions-gh-pages@v1.0.1"
|
||||
uses = "peaceiris/actions-gh-pages@v1.1.0"
|
||||
env = {
|
||||
PUBLISH_DIR = "./public"
|
||||
PUBLISH_BRANCH = "gh-pages"
|
||||
}
|
||||
secrets = ["ACTIONS_DEPLOY_KEY"]
|
||||
secrets = ["GITHUB_TOKEN"]
|
||||
}
|
||||
```
|
||||
|
||||
|
@ -115,12 +98,12 @@ action "mkdocs-build" {
|
|||
|
||||
action "deploy" {
|
||||
needs = ["mkdocs-build"]
|
||||
uses = "peaceiris/actions-gh-pages@v1.0.1"
|
||||
uses = "peaceiris/actions-gh-pages@v1.1.0"
|
||||
env = {
|
||||
PUBLISH_DIR = "./site"
|
||||
PUBLISH_BRANCH = "gh-pages"
|
||||
}
|
||||
secrets = ["ACTIONS_DEPLOY_KEY"]
|
||||
secrets = ["GITHUB_TOKEN"]
|
||||
}
|
||||
```
|
||||
|
||||
|
@ -137,5 +120,3 @@ action "deploy" {
|
|||
## About the author
|
||||
|
||||
- [peaceiris's homepage](https://peaceiris.com/)
|
||||
|
||||
<a href="https://www.patreon.com/peaceiris"><img src="./images/patreon.jpg" alt="peaceiris - Patreon" width="150px"></a>
|
||||
|
|
|
@ -1,31 +1,31 @@
|
|||
#!/bin/sh
|
||||
|
||||
# setup ssh
|
||||
if [ -z "${ACTIONS_DEPLOY_KEY}" ]; then
|
||||
echo "error: not found ACTIONS_DEPLOY_KEY"
|
||||
# check values
|
||||
if [ -z "${GITHUB_TOKEN}" ]; then
|
||||
echo "error: not found GITHUB_TOKEN"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -z "${PUBLISH_BRANCH}" ]; then
|
||||
echo "error: not found PUBLISH_BRANCH"
|
||||
exit 1
|
||||
fi
|
||||
mkdir /root/.ssh
|
||||
ssh-keyscan -t rsa github.com > /root/.ssh/known_hosts
|
||||
echo "${ACTIONS_DEPLOY_KEY}" > /root/.ssh/id_rsa
|
||||
chmod 400 /root/.ssh/id_rsa
|
||||
|
||||
# push to gh-pages branch
|
||||
if [ -z "${PUBLISH_DIR}" ]; then
|
||||
echo "error: not found PUBLISH_DIR"
|
||||
exit 1
|
||||
fi
|
||||
cd "${PUBLISH_DIR}" || exit 1
|
||||
if [ -z "${PUBLISH_BRANCH}" ]; then
|
||||
echo "error: not found PUBLISH_BRANCH"
|
||||
exit 1
|
||||
fi
|
||||
remote_repo="git@github.com:${GITHUB_REPOSITORY}.git"
|
||||
|
||||
# initialize git
|
||||
remote_repo="https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
|
||||
remote_branch="${PUBLISH_BRANCH}"
|
||||
git init
|
||||
git config user.name "${GITHUB_ACTOR}"
|
||||
git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
|
||||
git remote add origin "${remote_repo}"
|
||||
|
||||
# push to publishing branch
|
||||
git checkout "${remote_branch}" || git checkout --orphan "${remote_branch}"
|
||||
git add --all
|
||||
timestamp=$(date -u)
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 3.4 KiB |
Loading…
Reference in New Issue