github: Enhance action name

This flag should be used on local.
It is wasteful to use the Garbage Collection on CI.

.dependabot/config.yml

@@ -0,0 +1,10 @@
+version: 1
+update_configs:
+  - package_manager: "docker"
+    directory: "/"
+    update_schedule: "weekly"
+    default_labels:
+      - "dependencies"
+      - "docker"
+    commit_message:
+      prefix: "deps"

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @peaceiris

.github/FUNDING.yml

@@ -1,9 +0,0 @@
-# These are supported funding model platforms
-
-# 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
-custom: # Replace with a single custom sponsorship URL

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

@@ -1,6 +1,11 @@
 name: docker image ci
 
-on: push
+on:
+  pull_request:
+    types: [opened, synchronize]
+  push:
+    branches:
+    - master
 
 jobs:
   test:
@@ -8,6 +13,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@master
+      with:
+        fetch-depth: 1
 
     - name: build
       env:
@@ -20,6 +27,8 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
     - uses: actions/checkout@master
+      with:
+        fetch-depth: 1
     - name: shellcheck
       run: shellcheck ./entrypoint.sh
 
@@ -27,6 +36,8 @@ jobs:
     runs-on: macOS-10.14
     steps:
     - uses: actions/checkout@master
+      with:
+        fetch-depth: 1
     - name: hadolint
       run: |
         brew install hadolint

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.10.2
+FROM alpine:3.10.3
 
 RUN apk add --no-cache \
     bash \

README.md

@@ -1,39 +1,62 @@
 [![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)
+![GitHub Actions status](https://github.com/peaceiris/actions-gh-pages/workflows/docker%20image%20ci/badge.svg)
 [![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">
 
 
 
-## GitHub Actions for deploying to GitHub Pages
+## GitHub Actions for GitHub Pages
 
-A GitHub Action to deploy your static site to GitHub Pages with [Static Site Generators] (Hugo, MkDocs, Gatsby, GitBook, etc.)
+This is a **GitHub Action** to deploy your static files to **GitHub Pages**.
+This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, etc.)
 
 [Static Site Generators]: https://www.staticgen.com/
 
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v2.5.0
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+```
+
+The above example step will deploy `./public` directory to `gh-pages` branch.
+
+
+
+## Table of Contents
+
 <!-- 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)
+  - [(1) Add SSH deploy key](#1-add-ssh-deploy-key)
-  - [(2) Create `.github/workflows/gh-pages.yml`](#2-create-githubworkflowsgh-pagesyml)
+  - [(2) Create your workflow](#2-create-your-workflow)
-    - [:star: Repository type - Project](#star-repository-type---project)
+    - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
-    - [:star: Repository type - User and Organization](#star-repository-type---user-and-organization)
+    - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
-  - [Options](#options)
+- [Options](#options)
-    - [:star: Pull action image from Docker Hub](#star-pull-action-image-from-docker-hub)
+  - [⭐️ Pull action image from Docker Hub](#%EF%B8%8F-pull-action-image-from-docker-hub)
-    - [:star: `PERSONAL_TOKEN`](#star-personal_token)
+  - [⭐️ `PERSONAL_TOKEN`](#%EF%B8%8F-personal_token)
-    - [:star: `GITHUB_TOKEN`](#star-github_token)
+  - [⭐️ `GITHUB_TOKEN`](#%EF%B8%8F-github_token)
-    - [:star: Suppressing empty commits](#star-suppressing-empty-commits)
+  - [⭐️ Suppressing empty commits](#%EF%B8%8F-suppressing-empty-commits)
+  - [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
+  - [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
+  - [⭐️ Script mode](#%EF%B8%8F-script-mode)
+- [Tips and FAQ](#tips-and-faq)
+  - [⭐️ Use the latest and specific release](#%EF%B8%8F-use-the-latest-and-specific-release)
+  - [⭐️ How to add `CNAME`](#%EF%B8%8F-how-to-add-cname)
+  - [⭐️ Deployment completed but you cannot read](#%EF%B8%8F-deployment-completed-but-you-cannot-read)
 - [Examples](#examples)
-  - [Static Site Generators with Node.js](#static-site-generators-with-nodejs)
+  - [⭐️ Static Site Generators with Node.js](#%EF%B8%8F-static-site-generators-with-nodejs)
-  - [Gatsby](#gatsby)
+  - [⭐️ Gatsby](#%EF%B8%8F-gatsby)
-  - [React and Next](#react-and-next)
+  - [⭐️ React and Next](#%EF%B8%8F-react-and-next)
-  - [Vue and Nuxt](#vue-and-nuxt)
+  - [⭐️ Vue and Nuxt](#%EF%B8%8F-vue-and-nuxt)
-  - [Static Site Generators with Python](#static-site-generators-with-python)
+  - [⭐️ Static Site Generators with Python](#%EF%B8%8F-static-site-generators-with-python)
 - [License](#license)
 - [About the author](#about-the-author)
 
@@ -43,7 +66,7 @@ Table of Contents
 
 ## Getting started
 
-### (1) Add ssh deploy key
+### (1) Add SSH deploy key
 
 Generate your deploy key with the following command.
 
@@ -59,13 +82,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`
 
-### (2) Create `.github/workflows/gh-pages.yml`
+| Add your public key | Success |
+|---|---|
+| ![](./images/deploy-keys-1.jpg) | ![](./images/deploy-keys-2.jpg) |
 
-#### :star: Repository type - Project
+| Add your private key | Success |
+|---|---|
+| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
 
-An example yaml file with Hugo action.
+### (2) Create your workflow
 
-- [peaceiris/actions-hugo: GitHub Actions for Hugo extended](https://github.com/peaceiris/actions-hugo)
+Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch.
+
+#### ⭐️ Repository type - Project
+
+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)
 
@@ -85,14 +118,19 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
     - uses: actions/checkout@master
+      # with:
+      #   submodules: true
 
-    - name: build
+    - name: Setup Hugo
-      uses: peaceiris/actions-hugo@v0.58.1
+      uses: peaceiris/actions-hugo@v2.2.2
       with:
-        args: --gc --minify --cleanDestinationDir
+        hugo-version: '0.58.3'
 
-    - name: deploy
+    - name: Build
-      uses: peaceiris/actions-gh-pages@v2.3.0
+      run: hugo --minify
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2.5.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -101,7 +139,15 @@ jobs:
 
 The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
 
-#### :star: Repository type - User and Organization
+| 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`.
@@ -118,28 +164,29 @@ 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
 
-### Options
+![Change default branch](./images/default-branch.jpg)
 
-#### :star: Pull action image from Docker Hub
+<div align="right">
+<a href="#table-of-contents">Back to TOC ☝️</a>
+</div>
+
+
+
+## Options
+
+### ⭐️ 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.3.0
+- uses: peaceiris/actions-gh-pages@v2.5.0
-+ uses: docker://peaceiris/gh-pages:v2.3.0
++ uses: docker://peaceiris/gh-pages:v2.5.0
 ```
 
 - [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
 
-```diff
+### ⭐️ `PERSONAL_TOKEN`
-- uses: peaceiris/actions-hugo@v0.58.1
-+ uses: docker://peaceiris/gha-hugo:v0.58.1
-```
-
-- [peaceiris/gha-hugo - Docker Hub](https://hub.docker.com/r/peaceiris/gha-hugo)
-
-#### :star: `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`.
 
@@ -148,16 +195,20 @@ By pulling docker images, you can reduce the overall execution time of your work
 + PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
 ```
 
-#### :star: `GITHUB_TOKEN`
+### ⭐️ `GITHUB_TOKEN`
 
-> **NOTES**: This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. See #9
+> ⚠️ **NOTES**: `GITHUB_TOKEN` works only on a **private** repository.
+>
+> This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. GitHub team is investigating that. See [Issue #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 }}
 ```
 
-#### :star: Suppressing empty commits
+### ⭐️ 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]
 
@@ -166,8 +217,8 @@ By default, a commit will always be generated and pushed to the `PUBLISH_BRANCH`
 For example:
 
 ```yaml
-- name: deploy
+- name: Deploy
-  uses: peaceiris/actions-gh-pages@v2.3.0
+  uses: peaceiris/actions-gh-pages@v2.5.0
   env:
     ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
     PUBLISH_BRANCH: gh-pages
@@ -176,11 +227,131 @@ For example:
     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.5.0
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+  with:
+    keepFiles: true
+```
+
+### ⭐️ Deploy to external repository
+
+By default, your files are published to the repository which is running this action.
+If you want to publish to another repository on GitHub, set the environment variable `EXTERNAL_REPOSITORY` to `<username>/<external-repository>`.
+This option is available from `v2.5.0`.
+
+For example:
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v2.5.0
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    EXTERNAL_REPOSITORY: username/external-repository
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+```
+
+You can use `ACTIONS_DEPLOY_KEY` or `PERSONAL_TOKEN`.
+When you use `ACTIONS_DEPLOY_KEY`, set your private key to the repository which includes this action and set your public key to your external repository.
+
+Be careful, `GITHUB_TOKEN` has no permission to access to external repositories.
+
+### ⭐️ Script mode
+
+From `v2.5.0`, we can run this action as a shell script.
+There is no Docker build or pull step, so it will start immediately.
+
+- `ACTIONS_DEPLOY_KEY` requires `SCRIPT_MODE: true`
+- `*_TOKEN` do not require `SCRIPT_MODE`
+
+```yaml
+- name: Deploy
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+    SCRIPT_MODE: true
+  run: |
+    wget https://raw.githubusercontent.com/peaceiris/actions-gh-pages/v2.5.0/entrypoint.sh
+    bash ./entrypoint.sh
+```
+
+<div align="right">
+<a href="#table-of-contents">Back to TOC ☝️</a>
+</div>
+
+
+
+## Tips and FAQ
+
+### ⭐️ Use the latest and specific release
+
+We recommend you to use the latest and specific release of this action for stable CI/CD.
+It is useful to watch this repository (release only) to check the [latest release] of this action.
+
+[latest release]: https://github.com/peaceiris/actions-gh-pages/releases
+
+### ⭐️ 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.
+
+Does not your static site generator deal with the static files? No problem, you can add the file like the following.
+
+```yaml
+- name: Build
+  run: |
+    buildcommand
+    cp ./path/to/CNAME ./public/CNAME
+
+- name: Deploy
+```
+
+### ⭐️ 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.
+
+Does not your static site generator deal with the static files? No problem, you can add the file like the following.
+
+```yaml
+- name: Build
+  run: |
+    buildcommand
+    touch ./public/.nojekyll
+
+- name: Deploy
+```
+
+<div align="right">
+<a href="#table-of-contents">Back to TOC ☝️</a>
+</div>
+
 
 
 ## Examples
 
-### Static Site Generators with Node.js
+### ⭐️ Static Site Generators with Node.js
 
 [hexo], [gitbook], [vuepress], [react-static], [gridsome], etc.
 
@@ -211,20 +382,20 @@ jobs:
     - name: build
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
     - run: |
         npm install
         npm run build
 
     - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.3.0
+      uses: peaceiris/actions-gh-pages@v2.5.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: ./public
 ```
 
-### Gatsby
+### ⭐️ Gatsby
 
 An example for [Gatsby] (Gatsby.js) project with [gatsby-starter-blog]
 
@@ -250,7 +421,7 @@ jobs:
     - name: setup node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
 
     - name: install
       run: npm install
@@ -265,14 +436,14 @@ jobs:
       run: npm run build
 
     - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.3.0
+      uses: peaceiris/actions-gh-pages@v2.5.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: ./public
 ```
 
-### React and Next
+### ⭐️ React and Next
 
 An example for [Next.js] (React.js) project with [create-next-app]
 
@@ -300,7 +471,7 @@ jobs:
     - name: setup node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
 
     - name: install
       run: yarn install
@@ -315,14 +486,14 @@ jobs:
       run: touch ./out/.nojekyll
 
     - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.3.0
+      uses: peaceiris/actions-gh-pages@v2.5.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: ./out
 ```
 
-### Vue and Nuxt
+### ⭐️ Vue and Nuxt
 
 An example for [Nuxt.js] (Vue.js) project with [create-nuxt-app]
 
@@ -350,7 +521,7 @@ jobs:
     - name: setup node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
 
     - name: install
       run: npm install
@@ -362,14 +533,14 @@ jobs:
       run: npm run generate
 
     - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.3.0
+      uses: peaceiris/actions-gh-pages@v2.5.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: ./dist
 ```
 
-### Static Site Generators with Python
+### ⭐️ Static Site Generators with Python
 
 [pelican], [MkDocs], [sphinx], etc.
 
@@ -410,7 +581,7 @@ jobs:
       run: mkdocs build
 
     - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2.3.0
+      uses: peaceiris/actions-gh-pages@v2.5.0
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -430,3 +601,9 @@ jobs:
 ## About the author
 
 - [peaceiris's homepage](https://peaceiris.com/)
+
+
+
+<div align="right">
+<a href="#table-of-contents">Back to TOC ☝️</a>
+</div>

action.yml

@@ -1,5 +1,5 @@
-name: 'Deploy action for GitHub Pages'
+name: 'GitHub Pages action'
-description: 'A GitHub Action to deploy your static site to GitHub Pages with Static Site Generator'
+description: 'GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.'
 author: 'peaceiris'
 runs:
   using: 'docker'
@@ -12,3 +12,7 @@ inputs:
     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,29 +11,53 @@ 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 "${EXTERNAL_REPOSITORY}" ]; then
+    PUBLISH_REPOSITORY=${EXTERNAL_REPOSITORY}
+else
+    PUBLISH_REPOSITORY=${GITHUB_REPOSITORY}
+fi
+print_info "Deploy to ${PUBLISH_REPOSITORY}"
+
 if [ -n "${ACTIONS_DEPLOY_KEY}" ]; then
 
     print_info "setup with ACTIONS_DEPLOY_KEY"
 
-    mkdir /root/.ssh
+    if [ -n "${SCRIPT_MODE}" ]; then
-    ssh-keyscan -t rsa github.com > /root/.ssh/known_hosts
+        print_info "run as SCRIPT_MODE"
-    echo "${ACTIONS_DEPLOY_KEY}" > /root/.ssh/id_rsa
+        SSH_DIR="${HOME}/.ssh"
-    chmod 400 /root/.ssh/id_rsa
+    else
+        SSH_DIR="/root/.ssh"
+    fi
+    mkdir "${SSH_DIR}"
+    ssh-keyscan -t rsa github.com > "${SSH_DIR}/known_hosts"
+    echo "${ACTIONS_DEPLOY_KEY}" > "${SSH_DIR}/id_rsa"
+    chmod 400 "${SSH_DIR}/id_rsa"
 
-    remote_repo="git@github.com:${GITHUB_REPOSITORY}.git"
+    remote_repo="git@github.com:${PUBLISH_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"
+    remote_repo="https://x-access-token:${PERSONAL_TOKEN}@github.com/${PUBLISH_REPOSITORY}.git"
 
 elif [ -n "${GITHUB_TOKEN}" ]; then
 
     print_info "setup with GITHUB_TOKEN"
+    print_error "GITHUB_TOKEN works only private repo, See #9"
 
-    remote_repo="https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
+    if [ -n "${EXTERNAL_REPOSITORY}" ]; then
+        print_error "can not use GITHUB_TOKEN to deploy to a external repository"
+        exit 1
+    fi
+
+    remote_repo="https://x-access-token:${GITHUB_TOKEN}@github.com/${PUBLISH_REPOSITORY}.git"
 
 else
     print_error "not found ACTIONS_DEPLOY_KEY, PERSONAL_TOKEN, or GITHUB_TOKEN"
@@ -52,10 +76,16 @@ fi
 
 remote_branch="${PUBLISH_BRANCH}"
 
-local_dir="${HOME}/$(tr -cd 'a-f0-9' < /dev/urandom | head -c 32)"
+local_dir="${HOME}/ghpages_${RANDOM}"
 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}/"
@@ -74,12 +104,10 @@ git add --all
 
 print_info "Allowing empty commits: ${INPUT_EMPTYCOMMITS}"
 COMMIT_MESSAGE="Automated deployment: $(date -u) ${GITHUB_SHA}"
-if [[ ${INPUT_EMPTYCOMMITS} == "true" ]]; then
+if [[ ${INPUT_EMPTYCOMMITS} == "false" ]]; then
-    git commit --allow-empty -m "${COMMIT_MESSAGE}"
+    git commit -m "${COMMIT_MESSAGE}" || skip
 else
-    git commit -m "${COMMIT_MESSAGE}" || \
+    git commit --allow-empty -m "${COMMIT_MESSAGE}"
-      print_info "No changes detected, skipping deployment" && \
-      exit 0
 fi
 
 git push origin "${remote_branch}"