fix: avoid #29 for keepFiles option (#34)

* fix: avoid #29
* docs: update TOC
* docs: update tag to v2.4.0

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

@@ -1,10 +1,9 @@
 name: docker image ci
 
 on:
+  pull_request:
+    types: [opened, synchronize]
   push:
-    branches:
-    - master
-    - 'release-v*'
 
 jobs:
   test:
@@ -12,6 +11,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@master
+      with:
+        fetch-depth: 1
 
     - name: build
       env:
@@ -20,20 +21,12 @@ jobs:
         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
+      with:
+        fetch-depth: 1
     - name: shellcheck
       run: shellcheck ./entrypoint.sh
 
@@ -41,6 +34,8 @@ jobs:
     runs-on: macOS-10.14
     steps:
     - uses: actions/checkout@master
+      with:
+        fetch-depth: 1
     - name: hadolint
       run: |
         brew install hadolint

Dockerfile

@@ -4,8 +4,7 @@ RUN apk add --no-cache \
     bash \
     git \
     openssh-client \
-    ca-certificates && \
-    rm -rf /var/lib/apt/lists/*
+    ca-certificates
 
 COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT [ "/entrypoint.sh" ]

README.md

@@ -14,6 +14,35 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen
 
 [Static Site Generators]: https://www.staticgen.com/
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+Table of Contents
+
+- [Getting started](#getting-started)
+  - [(1) Add ssh deploy key](#1-add-ssh-deploy-key)
+  - [(2) Create `.github/workflows/gh-pages.yml`](#2-create-githubworkflowsgh-pagesyml)
+    - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
+    - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
+  - [Options](#options)
+    - [⭐️ Pull action image from Docker Hub](#%EF%B8%8F-pull-action-image-from-docker-hub)
+    - [⭐️ `PERSONAL_TOKEN`](#%EF%B8%8F-personal_token)
+    - [⭐️ `GITHUB_TOKEN`](#%EF%B8%8F-github_token)
+    - [⭐️ Suppressing empty commits](#%EF%B8%8F-suppressing-empty-commits)
+    - [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
+- [Tips and FAQ](#tips-and-faq)
+  - [How to add `CNAME`](#how-to-add-cname)
+  - [Deployment completed but you cannot read](#deployment-completed-but-you-cannot-read)
+- [Examples](#examples)
+  - [Static Site Generators with Node.js](#static-site-generators-with-nodejs)
+  - [Gatsby](#gatsby)
+  - [React and Next](#react-and-next)
+  - [Vue and Nuxt](#vue-and-nuxt)
+  - [Static Site Generators with Python](#static-site-generators-with-python)
+- [License](#license)
+- [About the author](#about-the-author)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 
 
 ## Getting started
@@ -23,7 +52,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)
@@ -34,11 +63,23 @@ 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`
 
+| Add your public key | Success |
+|---|---|
+| ![](./images/deploy-keys-1.jpg) | ![](./images/deploy-keys-2.jpg) |
+
+| Add your private key | Success |
+|---|---|
+| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
+
 ### (2) Create `.github/workflows/gh-pages.yml`
 
-An example yaml file with Hugo action.
+#### ⭐️ Repository type - Project
 
-- [peaceiris/actions-hugo: GitHub Actions for Hugo extended](https://github.com/peaceiris/actions-hugo)
+An example workflow for Hugo.
+
+- [peaceiris/actions-hugo: GitHub Actions for Hugo](https://github.com/peaceiris/actions-hugo)
+
+[![peaceiris/actions-hugo - GitHub](https://gh-card.dev/repos/peaceiris/actions-hugo.svg?fullname)](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)
@@ -56,55 +97,351 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
     - uses: actions/checkout@master
+      # with:
+      #   submodules: true
 
-    - name: build
-      uses: peaceiris/actions-hugo@v0.58.0
+    - name: Setup Hugo
+      uses: peaceiris/actions-hugo@v2.2.0
       with:
-        args: --gc --minify --cleanDestinationDir
+        hugo-version: '0.58.3'
 
-    - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.1.0
+    - name: Build
+      run: hugo --gc --minify --cleanDestinationDir
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2.4.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: ./public
 ```
 
+The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
+
+| Actions log overview | Build step log |
+|---|---|
+| ![](./images/log1.jpg) | ![](./images/log2.jpg) |
+
+| Deploy step log | GitHub Pages log |
+|---|---|
+| ![](./images/log3.jpg) | ![](./images/log4.jpg) |
+
+#### ⭐️ Repository type - User and Organization
+
+For [User and Organization Pages sites] (`<username>/<username>.github.io` repository),
+we have to set `master` branch to `PUBLISH_BRANCH`.
+
+```yaml
+on:
+  push:
+    branches:
+    - source  # default branch
+
+PUBLISH_BRANCH: master  # deploying branch
+```
+
+[Project Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#project-pages-sites
+[User and Organization Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#user-and-organization-pages-sites
+
+![Change default branch](./images/default-branch.jpg)
+
 ### Options
 
-#### Pull action image from Docker Hub
+#### ⭐️ 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
+- uses: peaceiris/actions-gh-pages@v2.4.0
++ uses: docker://peaceiris/gh-pages:v2.4.0
 ```
 
 - [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
 
+#### ⭐️ `PERSONAL_TOKEN`
+
+[Generate 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
-- uses: peaceiris/actions-hugo@v0.58.0
-+ uses: docker://peaceiris/gha-hugo:v0.58.0
+- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
++ PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
 ```
 
-- [peaceiris/gha-hugo - Docker Hub](https://hub.docker.com/r/peaceiris/gha-hugo)
+#### ⭐️ `GITHUB_TOKEN`
 
-### `GITHUB_TOKEN`
+> **NOTES**: Do not use `GITHUB_TOKEN`.
+>
+> This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. GitHub team is investigating that. See [Issue #9]
 
-> **NOTES**: This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. See #9
+[Issue #9]: https://github.com/peaceiris/actions-gh-pages/issues/9
 
 ```diff
 - ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
 + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+#### ⭐️ Suppressing empty commits
+
+By default, a commit will always be generated and pushed to the `PUBLISH_BRANCH`, even if nothing changed. If you want to suppress this behavior, set the optional parameter `emptyCommits` to `false`. cf. [Issue #21]
+
+[Issue #21]: https://github.com/peaceiris/actions-gh-pages/issues/21
+
+For example:
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v2.4.0
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+  with:
+    emptyCommits: false
+```
+
+#### ⭐️ Keeping existing files
+
+By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keepFiles` to `true`.
+
+For example:
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v2.4.0
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+  with:
+    keepFiles: true
+```
+
+
+
+## Tips and FAQ
+
+### How to add `CNAME`
+
+Most of the Static Site Generators support `CNAME` as a static file.
+
+- [Use a Custom Domain | Hugo](https://gohugo.io/hosting-and-deployment/hosting-on-github/#use-a-custom-domain)
+- [Using the Static folder | GatsbyJS](https://www.gatsbyjs.org/docs/static-folder/)
+
+The same may be said of other files (`.nojekyll`, `BingSiteAuth.xml`, `robots.txt`, etc.). It is better to manage those files by Static Site Generators.
+
+### Deployment completed but you cannot read
+
+Does your `PUBLISH_DIR` contain files or directories that name starts with an underscore? (`_modules`, `_sources` and `_next`, etc.)
+GitHub Pages does not read those by default.
+Please add `.nojekyll` file to `PUBLISH_DIR`.
+
+- [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
+
+> It is now possible to completely bypass Jekyll processing on GitHub Pages by creating a file named `.nojekyll` in the root of your pages repo and pushing it to GitHub. This should only be necessary if your site uses files or directories that start with underscores since Jekyll considers these to be special resources and does not copy them to the final site.
+
 
 
 ## Examples
 
-### MkDocs
+### Static Site Generators with Node.js
+
+[hexo], [gitbook], [vuepress], [react-static], [gridsome], etc.
+
+[hexo]: https://github.com/hexojs/hexo
+[gitbook]: https://github.com/GitbookIO/gitbook
+[vuepress]: https://github.com/vuejs/vuepress
+[react-static]: https://github.com/react-static/react-static
+[gridsome]: https://github.com/gridsome/gridsome
+
+Premise: Dependencies are managed by `package.json` and `package-lock.json`
+
+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+
+    - name: build
+      uses: actions/setup-node@v1
+      with:
+        node-version: '10.16'
+    - run: |
+        npm install
+        npm run build
+
+    - name: deploy
+      uses: peaceiris/actions-gh-pages@v2.4.0
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./public
+```
+
+### Gatsby
+
+An example for [Gatsby] (Gatsby.js) project with [gatsby-starter-blog]
+
+[Gatsby]: https://github.com/gatsbyjs/gatsby
+[gatsby-starter-blog]: https://github.com/gatsbyjs/gatsby-starter-blog
+
+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+
+    - name: setup node
+      uses: actions/setup-node@v1
+      with:
+        node-version: '10.16'
+
+    - name: install
+      run: npm install
+
+    - name: format
+      run: npm run format
+
+    - name: test
+      run: npm run test
+
+    - name: build
+      run: npm run build
+
+    - name: deploy
+      uses: peaceiris/actions-gh-pages@v2.4.0
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./public
+```
+
+### React and Next
+
+An example for [Next.js] (React.js) project with [create-next-app]
+
+- cf. [Deploying a Next.js app into GitHub Pages · zeit/next.js Wiki](https://github.com/zeit/next.js/wiki/Deploying-a-Next.js-app-into-GitHub-Pages)
+
+[Next.js]: https://github.com/zeit/next.js
+[create-next-app]: https://nextjs.org/docs
+
+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+
+    - name: setup node
+      uses: actions/setup-node@v1
+      with:
+        node-version: '10.16'
+
+    - name: install
+      run: yarn install
+
+    - name: build
+      run: yarn build
+
+    - name: export
+      run: yarn export
+
+    - name: add nojekyll
+      run: touch ./out/.nojekyll
+
+    - name: deploy
+      uses: peaceiris/actions-gh-pages@v2.4.0
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./out
+```
+
+### Vue and Nuxt
+
+An example for [Nuxt.js] (Vue.js) project with [create-nuxt-app]
+
+- cf. [GitHub Pages Deployment - Nuxt.js](https://nuxtjs.org/faq/github-pages)
+
+[Nuxt.js]: https://github.com/nuxt/nuxt.js
+[create-nuxt-app]: https://github.com/nuxt/create-nuxt-app
+
+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+
+    - name: setup node
+      uses: actions/setup-node@v1
+      with:
+        node-version: '10.16'
+
+    - name: install
+      run: npm install
+
+    - name: test
+      run: npm test
+
+    - name: generate
+      run: npm run generate
+
+    - name: deploy
+      uses: peaceiris/actions-gh-pages@v2.4.0
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./dist
+```
+
+### Static Site Generators with Python
+
+[pelican], [MkDocs], [sphinx], etc.
+
+[pelican]: https://github.com/getpelican/pelican
+[MkDocs]: https://github.com/mkdocs/mkdocs
+[sphinx]: https://github.com/sphinx-doc/sphinx
+
+Premise: Dependencies are managed by `requirements.txt`
 
 ![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
 
@@ -133,11 +470,11 @@ jobs:
         pip install --upgrade pip
         pip install -r ./requirements.txt
 
-    - name: Build with MkDocs
+    - name: Build
       run: mkdocs build
 
-    - name: Deploy to GitHub Pages
-      uses: peaceiris/actions-gh-pages@v2.1.0
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2.4.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages

action.yml

@@ -7,3 +7,12 @@ runs:
 branding:
   icon: 'upload-cloud'
   color: 'blue'
+inputs:
+  emptyCommits:
+    description: 'If empty commits should be made to the publication branch'
+    required: false
+    default: 'true'
+  keepFiles:
+    description: 'If existing files in the publish branch should be not removed before deploying'
+    required: false
+    default: 'false'

entrypoint.sh

@@ -11,6 +11,11 @@ function print_info() {
     echo -e "\e[36mINFO: ${1}\e[m"
 }
 
+function skip() {
+    print_info "No changes detected, skipping deployment"
+    exit 0
+}
+
 # check values
 if [ -n "${ACTIONS_DEPLOY_KEY}" ]; then
 
@@ -23,14 +28,21 @@ 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"
+    print_error "Do not use GITHUB_TOKEN, See #9"
 
-    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
 
@@ -49,7 +61,13 @@ remote_branch="${PUBLISH_BRANCH}"
 local_dir="${HOME}/$(tr -cd 'a-f0-9' < /dev/urandom | head -c 32)"
 if git clone --depth=1 --single-branch --branch "${remote_branch}" "${remote_repo}" "${local_dir}"; then
     cd "${local_dir}"
-    git rm -r '*'
+
+    if [[ ${INPUT_KEEPFILES} == "true" ]]; then
+        print_info "Keeping existing files: ${INPUT_KEEPFILES}"
+    else
+        git rm -r --ignore-unmatch '*'
+    fi
+
     find "${GITHUB_WORKSPACE}/${PUBLISH_DIR}" -maxdepth 1 | \
         tail -n +2 | \
         xargs -I % cp -rf % "${local_dir}/"
@@ -65,6 +83,14 @@ git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
 git remote rm origin || true
 git remote add origin "${remote_repo}"
 git add --all
-git commit --allow-empty -m "Automated deployment: $(date -u) ${GITHUB_SHA}"
+
+print_info "Allowing empty commits: ${INPUT_EMPTYCOMMITS}"
+COMMIT_MESSAGE="Automated deployment: $(date -u) ${GITHUB_SHA}"
+if [[ ${INPUT_EMPTYCOMMITS} == "false" ]]; then
+    git commit -m "${COMMIT_MESSAGE}" || skip
+else
+    git commit --allow-empty -m "${COMMIT_MESSAGE}"
+fi
+
 git push origin "${remote_branch}"
 print_info "${GITHUB_SHA} was successfully deployed"