Compare commits

..

6 Commits

Author SHA1 Message Date
Shohei Ueda
b263205b1b Release v2.2.0 (#19)
* try to fix: remote repo URL for GITHUB_TOKEN

cf. https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#http-based-git-access-by-an-installation

* add: PERSONAL_TOKEN
* update: readme about PERSONAL_TOKEN
2019-09-08 04:24:03 +09:00
peaceiris
8fd3a55a6f fix: readme 2019-09-06 01:16:44 +09:00
peaceiris
61579670d5 enhance: readme 2019-09-06 00:50:59 +09:00
peaceiris
809601eb1f update: readme from v2.0.0 to v2.1.0 2019-09-06 00:33:20 +09:00
Shohei Ueda
45f5817ce0 Release v2.1.0 (#14)
* change: base docker image from ubuntu:18.04 to alpine:3.10.2
* update: .hadolint.yaml to ignore DL3018
2019-09-06 00:31:34 +09:00
peaceiris
713b37219b update: .dockerignore 2019-09-05 23:38:50 +09:00
5 changed files with 29 additions and 11 deletions

View File

@@ -1,5 +1,7 @@
.git
.github
.hadolint.yaml
LICENSE
README.md
action.yml
images

View File

@@ -1,2 +1,2 @@
ignored:
- DL3008
- DL3018

View File

@@ -1,6 +1,7 @@
FROM ubuntu:18.04
FROM alpine:3.10.2
RUN apt-get update && apt-get install -y --no-install-recommends \
RUN apk add --no-cache \
bash \
git \
openssh-client \
ca-certificates && \

View File

@@ -23,7 +23,7 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
Generate your deploy key with the following command.
```sh
ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N ""
ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""
# You will get 2 files:
# gh-pages.pub (public key)
# gh-pages (private key)
@@ -63,7 +63,7 @@ jobs:
args: --gc --minify --cleanDestinationDir
- name: deploy
uses: peaceiris/actions-gh-pages@v2.0.0
uses: peaceiris/actions-gh-pages@v2.1.0
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
PUBLISH_BRANCH: gh-pages
@@ -78,8 +78,8 @@ You can pull a public docker image from Docker Hub.
By pulling docker images, you can reduce the overall execution time of your workflow. In addition, `latest` tag is provided.
```diff
- uses: peaceiris/actions-gh-pages@v2.0.0
+ uses: docker://peaceiris/gh-pages:v2.0.0
- uses: peaceiris/actions-gh-pages@v2.1.0
+ uses: docker://peaceiris/gh-pages:v2.1.0
```
- [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
@@ -91,7 +91,16 @@ By pulling docker images, you can reduce the overall execution time of your work
- [peaceiris/gha-hugo - Docker Hub](https://hub.docker.com/r/peaceiris/gha-hugo)
### `GITHUB_TOKEN`
#### `PERSONAL_TOKEN`
[Create a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
```diff
- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+ PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
```
#### `GITHUB_TOKEN`
> **NOTES**: This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. See #9
@@ -137,7 +146,7 @@ jobs:
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v2.0.0
uses: peaceiris/actions-gh-pages@v2.1.0
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
PUBLISH_BRANCH: gh-pages

View File

@@ -23,14 +23,20 @@ if [ -n "${ACTIONS_DEPLOY_KEY}" ]; then
remote_repo="git@github.com:${GITHUB_REPOSITORY}.git"
elif [ -n "${PERSONAL_TOKEN}" ]; then
print_info "setup with PERSONAL_TOKEN"
remote_repo="https://x-access-token:${PERSONAL_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
elif [ -n "${GITHUB_TOKEN}" ]; then
print_info "setup with GITHUB_TOKEN"
remote_repo="https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
remote_repo="https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
else
print_error "not found ACTIONS_DEPLOY_KEY or GITHUB_TOKEN"
print_error "not found ACTIONS_DEPLOY_KEY, PERSONAL_TOKEN, or GITHUB_TOKEN"
exit 1
fi