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

.dockerignore

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

.github/FUNDING.yml

@@ -1,7 +1,8 @@
 # These are supported funding model platforms
 
-github: peaceiris
+# github: peaceiris
 patreon: peaceiris
+issuehunt: peaceiris
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

.github/main.workflow

@@ -1,9 +0,0 @@
-workflow "Main workflow" {
-  on = "push"
-  resolves = ["docker-build"]
-}
-
-action "docker-build" {
-  uses = "actions/docker/cli@master"
-  args = "build -t peaceiris/actions-gh-deploy ."
-}

.github/workflows/docker-image-ci.yml

@@ -0,0 +1,47 @@
+name: docker image ci
+
+on:
+  push:
+    branches:
+    - master
+    - 'release-v*'
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+
+    steps:
+    - uses: actions/checkout@master
+
+    - name: build
+      env:
+        DOCKER_IMAGE: docker.pkg.github.com/${{ github.repository }}/action:latest
+      run: |
+        docker build . --file Dockerfile --tag ${DOCKER_IMAGE} ||
+        (echo -e "\e[31m[${GITHUB_WORKFLOW}] failed to build\e[m" && exit 1)
+
+    # - name: push latest image
+    #   if: endsWith(github.ref, 'master')
+    #   env:
+    #     DOCKER_IMAGE: docker.pkg.github.com/${{ github.repository }}/action:latest
+    #     PKG_GITHUB_TOKEN: ${{ secrets.PKG_GITHUB_TOKEN }}
+    #   run: |
+    #     echo ${PKG_GITHUB_TOKEN} | docker login docker.pkg.github.com -u ${GITHUB_ACTOR} --password-stdin &&
+    #     docker push ${DOCKER_IMAGE} &&
+    #     docker logout
+
+  shellcheck:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+    - name: shellcheck
+      run: shellcheck ./entrypoint.sh
+
+  hadolint:
+    runs-on: macOS-10.14
+    steps:
+    - uses: actions/checkout@master
+    - name: hadolint
+      run: |
+        brew install hadolint
+        hadolint ./Dockerfile

.hadolint.yaml

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

Dockerfile

@@ -1,17 +1,11 @@
-FROM alpine:3.9
+FROM alpine:3.10.2
-
-LABEL "com.github.actions.name"="Deploy to GitHub Pages for Static Site Generator"
-LABEL "com.github.actions.description"="A GitHub Action to deploy your static site to GitHub Pages with Static Site Generator"
-LABEL "com.github.actions.icon"="upload-cloud"
-LABEL "com.github.actions.color"="blue"
-
-LABEL "repository"="https://github.com/peaceiris/actions-gh-pages"
-LABEL "homepage"="https://github.com/peaceiris/actions-gh-pages"
-LABEL "maintainer"="peaceiris"
 
 RUN apk add --no-cache \
+    bash \
     git \
-    openssh-client
+    openssh-client \
+    ca-certificates && \
+    rm -rf /var/lib/apt/lists/*
 
-ADD entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT [ "/entrypoint.sh" ]

README.md

@@ -1,6 +1,8 @@
 [![license](https://img.shields.io/github/license/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/blob/master/LICENSE)
 [![release](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases/latest)
 [![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases)
+[![GitHub Actions status](https://github.com/peaceiris/actions-gh-pages/workflows/docker%20image%20ci/badge.svg)](https://github.com/peaceiris/actions-gh-pages/actions)
+[![Docker Hub Build Status](https://img.shields.io/docker/cloud/build/peaceiris/gh-pages.svg)](https://hub.docker.com/r/peaceiris/gh-pages)
 
 <img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="./images/ogp.svg">
 
@@ -16,51 +18,96 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
 
 ## Getting started
 
-### Create `.github/main.workflow`
+### (1) Add ssh deploy key
 
-An example with Hugo action.
+Generate your deploy key with the following command.
+
+```sh
+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)
+```
+
+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 `.github/workflows/gh-pages.yml`
+
+An example yaml file with Hugo action.
 
 - [peaceiris/actions-hugo: GitHub Actions for Hugo extended](https://github.com/peaceiris/actions-hugo)
 
 ![peaceiris/actions-hugo latest version](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo)
 ![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
 
-```hcl
+```yaml
-workflow "GitHub Pages" {
+name: github pages
-  on = "push"
-  resolves = ["deploy"]
-}
 
-action "is-branch-master" {
+on:
-  uses = "actions/bin/filter@master"
+  push:
-  args = "branch master"
+    branches:
-}
+    - master
 
-action "is-not-branch-deleted" {
+jobs:
-  uses = "actions/bin/filter@master"
+  build-deploy:
-  args = "not deleted"
+    runs-on: ubuntu-18.04
-}
+    steps:
+    - uses: actions/checkout@master
 
-action "build" {
+    - name: build
-  needs = ["is-branch-master", "is-not-branch-deleted"]
+      uses: peaceiris/actions-hugo@v0.58.0
-  uses = "peaceiris/actions-hugo@v0.56.3"
+      with:
-  args = ["--gc", "--minify", "--cleanDestinationDir"]
+        args: --gc --minify --cleanDestinationDir
-}
 
-action "deploy" {
+    - name: deploy
-  needs = "build"
+      uses: peaceiris/actions-gh-pages@v2.1.0
-  uses = "peaceiris/actions-gh-pages@v1.1.0"
+      env:
-  env = {
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    PUBLISH_DIR = "./public"
+        PUBLISH_BRANCH: gh-pages
-    PUBLISH_BRANCH = "gh-pages"
+        PUBLISH_DIR: ./public
-  }
-  secrets = ["GITHUB_TOKEN"]
-}
 ```
 
-| Workflow overview | Actions log |
+### Options
-|---|---|
+
-| ![GitHub Actions for deploying to GitHub Pages Workflow overview](./images/workflow-1.jpg) | ![GitHub Actions for deploying to GitHub Pages Actions log](./images/workflow-2.jpg) |
+#### Pull action image from Docker Hub
+
+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.1.0
++ uses: docker://peaceiris/gh-pages:v2.1.0
+```
+
+- [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
+
+```diff
+- uses: peaceiris/actions-hugo@v0.58.0
++ uses: docker://peaceiris/gha-hugo:v0.58.0
+```
+
+- [peaceiris/gha-hugo - Docker Hub](https://hub.docker.com/r/peaceiris/gha-hugo)
+
+#### `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
+
+```diff
+- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
++ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
 
 
 
@@ -68,50 +115,49 @@ action "deploy" {
 
 ### MkDocs
 
-- [peaceiris/actions-pipenv: GitHub Actions for pipenv](https://github.com/peaceiris/actions-pipenv)
-- [main.workflow - peaceiris/mkdocs-material-boilerplate](https://github.com/peaceiris/mkdocs-material-boilerplate/blob/master/.github/main.workflow)
-
 ![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
 
-```hcl
+```yaml
-workflow "MkDocs workflow" {
+name: github pages
-  on = "push"
-  resolves = ["deploy"]
-}
 
-action "branch-filter" {
+on:
-  uses = "actions/bin/filter@master"
+  push:
-  args = "branch master"
+    branches:
-}
+    - master
 
-action "pipenv-sync" {
+jobs:
-  needs = ["branch-filter"]
+  build-deploy:
-  uses = "peaceiris/actions-pipenv@3.6"
+    runs-on: ubuntu-18.04
-  args = "sync"
+    steps:
-}
+    - uses: actions/checkout@v1
 
-action "mkdocs-build" {
+    - name: Set up Python
-  needs = ["pipenv-sync"]
+      uses: actions/setup-python@v1
-  uses = "peaceiris/actions-pipenv@3.6"
+      with:
-  args = ["run", "mkdocs", "build", "--config-file", "./mkdocs-sample.yml"]
+        python-version: '3.6'
-}
+        architecture: 'x64'
 
-action "deploy" {
+    - name: Install dependencies
-  needs = ["mkdocs-build"]
+      run: |
-  uses = "peaceiris/actions-gh-pages@v1.1.0"
+        pip install --upgrade pip
-  env = {
+        pip install -r ./requirements.txt
-    PUBLISH_DIR = "./site"
+
-    PUBLISH_BRANCH = "gh-pages"
+    - name: Build with MkDocs
-  }
+      run: mkdocs build
-  secrets = ["GITHUB_TOKEN"]
+
-}
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v2.1.0
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./site
 ```
 
 
 
 ## License
 
-[MIT License - peaceiris/actions-gh-pages]
+- [MIT License - peaceiris/actions-gh-pages]
 
 [MIT License - peaceiris/actions-gh-pages]: https://github.com/peaceiris/actions-gh-pages/blob/master/LICENSE
 

action.yml

@@ -0,0 +1,9 @@
+name: 'Deploy action for GitHub Pages'
+description: 'A GitHub Action to deploy your static site to GitHub Pages with Static Site Generator'
+author: 'peaceiris'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+branding:
+  icon: 'upload-cloud'
+  color: 'blue'

entrypoint.sh

@@ -1,33 +1,76 @@
-#!/bin/sh
+#!/bin/bash
+
+set -e
+# set -ex
+
+function print_error() {
+    echo -e "\e[31mERROR: ${1}\e[m"
+}
+
+function print_info() {
+    echo -e "\e[36mINFO: ${1}\e[m"
+}
 
 # check values
-if [ -z "${GITHUB_TOKEN}" ]; then
+if [ -n "${ACTIONS_DEPLOY_KEY}" ]; then
-    echo "error: not found GITHUB_TOKEN"
+
+    print_info "setup with ACTIONS_DEPLOY_KEY"
+
+    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
+
+    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://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
+
+else
+    print_error "not found ACTIONS_DEPLOY_KEY, PERSONAL_TOKEN, or GITHUB_TOKEN"
     exit 1
 fi
 
 if [ -z "${PUBLISH_BRANCH}" ]; then
-    echo "error: not found PUBLISH_BRANCH"
+    print_error "not found PUBLISH_BRANCH"
     exit 1
 fi
 
 if [ -z "${PUBLISH_DIR}" ]; then
-    echo "error: not found PUBLISH_DIR"
+    print_error "not found PUBLISH_DIR"
     exit 1
 fi
-cd "${PUBLISH_DIR}" || exit 1
 
-# 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}"
+local_dir="${HOME}/$(tr -cd 'a-f0-9' < /dev/urandom | head -c 32)"
-git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+if git clone --depth=1 --single-branch --branch "${remote_branch}" "${remote_repo}" "${local_dir}"; then
-git remote add origin "${remote_repo}"
+    cd "${local_dir}"
+    git rm -r '*'
+    find "${GITHUB_WORKSPACE}/${PUBLISH_DIR}" -maxdepth 1 | \
+        tail -n +2 | \
+        xargs -I % cp -rf % "${local_dir}/"
+else
+    cd "${PUBLISH_DIR}"
+    git init
+    git checkout --orphan "${remote_branch}"
+fi
 
 # push to publishing branch
-git checkout "${remote_branch}" || git checkout --orphan "${remote_branch}"
+git config user.name "${GITHUB_ACTOR}"
+git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+git remote rm origin || true
+git remote add origin "${remote_repo}"
 git add --all
-timestamp=$(date -u)
+git commit --allow-empty -m "Automated deployment: $(date -u) ${GITHUB_SHA}"
-git commit -m "Automated deployment: ${timestamp} ${GITHUB_SHA}"
+git push origin "${remote_branch}"
-git push origin "${remote_branch}" --force
+print_info "${GITHUB_SHA} was successfully deployed"