chore(release): 3.3.0

* feat: Add disable_nojekyll and cname options
* docs: Add cname and disable_nojekyll
* chore: Add vim
* chore(release): 3.3.0-0
* ci: Add codecov/codecov-action
* refactor: Enhance warning message

- Add .nojekyll file by default to only the master and gh-pages branches. When the file already exists, this action does nothing.
- When we set other branches to publish_branch, this action does not add .nojekyll file.

cf. https://github.com/peaceiris/actions-gh-pages/issues/112#issuecomment-589678269

Close #112

Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Nicolas Vanhoren <nicolas.vanhoren@gmail.com>

.dependabot/config.yml

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

.dockerignore

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

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[Makefile]
+indent_size = 4
+indent_style = tab

.envrc

@@ -0,0 +1,3 @@
+nvmrc=~/.nvm/nvm.sh
+source $nvmrc
+nvm use

.eslintrc.json

@@ -0,0 +1,24 @@
+{
+  "env": {
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest/recommended"
+  ],
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2019
+  },
+  "rules": {
+  }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'Bug: This is a sample issue title'
+labels: bug
+assignees: peaceiris
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Your YAML file**
+- A link to your repository
+- A link to your YAML file
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Actions Community Forum
+    url: https://github.community/t5/GitHub-Actions/bd-p/actions
+    about: Please ask questions about GitHub Actions here.
+  - name: GitHub Pages help
+    url: https://help.github.com/en/github/working-with-github-pages
+    about: GitHub Pages documentaion here.

.github/ISSUE_TEMPLATE/proposal.md

@@ -0,0 +1,20 @@
+---
+name: Proposal
+about: Suggest an idea for this project
+title: 'proposal: This is a sample title'
+labels: proposal
+assignees: peaceiris
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

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

@@ -1,44 +0,0 @@
-name: docker image ci
-
-on:
-  pull_request:
-    types: [opened, synchronize]
-  push:
-    branches:
-    - master
-
-jobs:
-  test:
-    runs-on: ubuntu-18.04
-
-    steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 1
-
-    - 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)
-
-  shellcheck:
-    runs-on: ubuntu-18.04
-    steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 1
-    - name: shellcheck
-      run: shellcheck ./entrypoint.sh
-
-  hadolint:
-    runs-on: macOS-10.14
-    steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 1
-    - name: hadolint
-      run: |
-        brew install hadolint
-        hadolint ./Dockerfile

.github/workflows/purge-readme-image-cache.yml

@@ -0,0 +1,16 @@
+name: Purge image cache
+
+on:
+  schedule:
+    - cron: '54 18 * * */7'
+
+jobs:
+  purge:
+    runs-on: ubuntu-18.04
+    steps:
+
+    - run: >
+        curl -sL https://github.com/${GITHUB_REPOSITORY} |
+        grep -oE '<img src="https?://camo.githubusercontent.com/[^"]+' |
+        sed -e 's/<img src="//' |
+        xargs -I % curl -sX PURGE %

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - 'v3.*.*'
+
+jobs:
+  release:
+    runs-on: ubuntu-18.04
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "${GITHUB_CONTEXT}"
+
+      - name: Install github/hub
+        run: |
+          export HUB_VERSION="2.14.1"
+          curl -fsSL https://github.com/github/hub/raw/40e421edd2c63d57bb8daa4bb9bbdfa21e8becf9/script/get | bash -s "${HUB_VERSION}"
+
+      - name: Create release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          TAG_NAME="${GITHUB_REF##refs/tags/}"
+          echo "See [CHANGELOG.md](https://github.com/${GITHUB_REPOSITORY}/blob/${TAG_NAME}/CHANGELOG.md) for more details." > ./release_notes.md
+          RELEASE_NAME="$(jq -r '.name' ./package.json)"
+          sed -i "1i${RELEASE_NAME} ${TAG_NAME}\n" ./release_notes.md
+          ./bin/hub release create \
+            --draft \
+            --prerelease \
+            --file ./release_notes.md \
+            "${TAG_NAME}"

.github/workflows/stale.yml

@@ -0,0 +1,17 @@
+name: "Stale"
+
+on:
+  schedule:
+  - cron: "6 6 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/stale@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue is stale because it has been open 21 days with no activity. Remove stale label or comment or this will be closed in 7 days.'
+        stale-pr-message: 'This pull request is stale because it has been open 21 days with no activity. Remove stale label or comment or this will be closed in 7 days.'
+        days-before-stale: 21
+        days-before-close: 7

.github/workflows/test-action.yml

@@ -0,0 +1,105 @@
+name: Test Action
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '*.md'
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths-ignore:
+      - '*.md'
+
+jobs:
+  skipci:
+    runs-on: ubuntu-18.04
+    steps:
+      - run: echo "[Skip CI] ${{ contains(github.event.head_commit.message, '[skip ci]') }}"
+
+  test:
+    runs-on: ${{ matrix.os }}
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+    strategy:
+      max-parallel: 1
+      matrix:
+        os:
+          - 'ubuntu-18.04'
+          - 'macos-latest'
+          - 'windows-latest'
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Read .nvmrc
+        run: echo "::set-output name=NVMRC::$(cat .nvmrc)"
+        id: nvm
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '${{ steps.nvm.outputs.NVMRC }}'
+
+      - run: npm ci
+
+      - name: Remove lint-staged husky
+        run: |
+          npm uninstall lint-staged husky
+          git checkout package-lock.json package.json
+
+      - run: npm run build
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.3.5'
+
+      - name: Build
+        working-directory: ./test_projects/mdbook
+        run: mdbook build
+
+      - name: Prepare tag
+        id: prepare_tag
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          TAG_NAME="${GITHUB_REF##refs/tags/}"
+          echo "::set-output name=tag_name::${TAG_NAME}"
+          echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"
+
+      - name: Deploy
+        if: matrix.os != 'windows-latest'
+        uses: ./
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          # github_token: ${{ secrets.GITHUB_TOKEN }}
+          # publish_branch: gh-pages
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          # keep_files: true
+          # force_orphan: true
+          # user_name: iris
+          # user_email: email@peaceiris.com
+          # commit_message: ${{ github.event.head_commit.message }}
+          # tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
+          # tag_message: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'
+
+      - name: Deploy
+        if: matrix.os == 'windows-latest'
+        uses: ./
+        with:
+          # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # personal_token: ${{ secrets.PERSONAL_TOKEN }}
+          # publish_branch: gh-pages
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          # keep_files: true
+          # force_orphan: true
+          # user_name: iris
+          # user_email: email@peaceiris.com
+          # commit_message: ${{ github.event.head_commit.message }}
+          # tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
+          # tag_message: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'

.github/workflows/test.yml

@@ -0,0 +1,68 @@
+name: 'Test'
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '*.md'
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths-ignore:
+      - '*.md'
+
+jobs:
+  skipci:
+    runs-on: ubuntu-18.04
+    steps:
+      - run: echo "[Skip CI] ${{ contains(github.event.head_commit.message, '[skip ci]') }}"
+
+  test:
+    runs-on: ${{ matrix.os }}
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+    strategy:
+      matrix:
+        os:
+          - 'ubuntu-18.04'
+          - 'macos-latest'
+          - 'windows-latest'
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - name: Read .nvmrc
+        run: echo "::set-output name=NVMRC::$(cat .nvmrc)"
+        id: nvm
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '${{ steps.nvm.outputs.NVMRC }}'
+
+      - run: npm ci
+
+      - name: Run prettier
+        if: startsWith(matrix.os, 'ubuntu')
+        run: npm run format:check
+
+      - name: Run eslint
+        if: startsWith(matrix.os, 'ubuntu')
+        run: npm run lint
+
+      - name: Run ncc
+        if: startsWith(matrix.os, 'ubuntu')
+        run: npm run build
+
+      - run: npm test
+
+      - name: Upload test coverage as artifact
+        uses: actions/upload-artifact@v1
+        with:
+          name: coverage
+          path: coverage
+
+      - uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/update-major-tag.yml

@@ -0,0 +1,23 @@
+name: Update major tag
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  update:
+    runs-on: ubuntu-18.04
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - name: Update major tag
+      if: github.event.release.prerelease == false
+      run: |
+        git config user.name "${GITHUB_ACTOR}"
+        git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+        git remote set-url origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
+        export TAG_NAME="${GITHUB_REF##refs/tags/}"
+        export TAG_MAJOR="${TAG_NAME%%.*}"
+        git tag --force -a "${TAG_MAJOR}" -m "Release ${TAG_NAME}"
+        git push --force origin "${TAG_MAJOR}"

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+coverage
+.npm
+.eslintcache
+.env
+node_modules

.hadolint.yaml

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

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+12.15.0

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid",
+  "parser": "typescript"
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "git.ignoreLimitWarning": true
+}

CHANGELOG.md

@@ -0,0 +1,253 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+# [3.3.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.2.0...v3.3.0) (2020-02-24)
+
+
+### deps
+
+* bump @actions/github from 2.1.0 to 2.1.1 (#120) ([5d3cd50](https://github.com/peaceiris/actions-gh-pages/commit/5d3cd509d9e8ab8ba8b6c6981eb8ecb077ab2109)), closes [#120](https://github.com/peaceiris/actions-gh-pages/issues/120)
+* bump @types/jest from 25.1.2 to 25.1.3 (#118) ([0b1dd44](https://github.com/peaceiris/actions-gh-pages/commit/0b1dd44709acc2ba27cf43e181767b92e78d1577)), closes [#118](https://github.com/peaceiris/actions-gh-pages/issues/118)
+* bump @types/node from 12.12.27 to 12.12.28 (#122) ([b243caf](https://github.com/peaceiris/actions-gh-pages/commit/b243cafb6e6598d71925399552d569a628a42aa7)), closes [#122](https://github.com/peaceiris/actions-gh-pages/issues/122)
+* bump @zeit/ncc from 0.21.0 to 0.21.1 (#101) ([6244b19](https://github.com/peaceiris/actions-gh-pages/commit/6244b197b6c5a57172d87769cd03d79cedae9dca)), closes [#101](https://github.com/peaceiris/actions-gh-pages/issues/101)
+* bump ts-jest from 25.2.0 to 25.2.1 (#117) ([e1bf32a](https://github.com/peaceiris/actions-gh-pages/commit/e1bf32ad68fadb9a32147579d6dc49b51d6ddefb)), closes [#117](https://github.com/peaceiris/actions-gh-pages/issues/117)
+* bump typescript from 3.7.5 to 3.8.2 (#121) ([e58a6c1](https://github.com/peaceiris/actions-gh-pages/commit/e58a6c156e7249d4e6052539e2ed0aa449bdd4f4)), closes [#121](https://github.com/peaceiris/actions-gh-pages/issues/121)
+
+### feat
+
+* Add disable_nojekyll and cname options (#119) ([00fde1e](https://github.com/peaceiris/actions-gh-pages/commit/00fde1eb97e54d4fa89f31806ff2815878fafcb6)), closes [#119](https://github.com/peaceiris/actions-gh-pages/issues/119) [/github.com/peaceiris/actions-gh-pages/issues/112#issuecomment-589678269](https://github.com//github.com/peaceiris/actions-gh-pages/issues/112/issues/issuecomment-589678269) [#112](https://github.com/peaceiris/actions-gh-pages/issues/112)
+
+
+
+# [3.3.0-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.2.0...v3.3.0-0) (2020-02-20)
+
+
+### chore
+
+* Add vim ([b9a6975](https://github.com/peaceiris/actions-gh-pages/commit/b9a697582713e95c1d628172933226631d3825af))
+
+### deps
+
+* bump @types/jest from 25.1.2 to 25.1.3 (#118) ([0b1dd44](https://github.com/peaceiris/actions-gh-pages/commit/0b1dd44709acc2ba27cf43e181767b92e78d1577)), closes [#118](https://github.com/peaceiris/actions-gh-pages/issues/118)
+* bump ts-jest from 25.2.0 to 25.2.1 (#117) ([e1bf32a](https://github.com/peaceiris/actions-gh-pages/commit/e1bf32ad68fadb9a32147579d6dc49b51d6ddefb)), closes [#117](https://github.com/peaceiris/actions-gh-pages/issues/117)
+
+### feat
+
+* Add disable_nojekyll and cname options ([7c4b591](https://github.com/peaceiris/actions-gh-pages/commit/7c4b591cf65cf4daf0464fba89b32ff4e764b427)), closes [#112](https://github.com/peaceiris/actions-gh-pages/issues/112)
+
+
+
+# [3.2.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.1.0...v3.2.0) (2020-02-19)
+
+
+### feat
+
+* Remove warning about GITHUB_TOKEN (#108) ([74f652a](https://github.com/peaceiris/actions-gh-pages/commit/74f652acfdfc3290f8b6f7c5e65fd1f563412cf5)), closes [#108](https://github.com/peaceiris/actions-gh-pages/issues/108) [#9](https://github.com/peaceiris/actions-gh-pages/issues/9)
+
+
+
+# [3.1.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.3...v3.1.0) (2020-02-19)
+
+
+### deps
+
+* bump @types/jest from 25.1.1 to 25.1.2 (#93) ([aec195e](https://github.com/peaceiris/actions-gh-pages/commit/aec195ebb4e984f62f48139a5e24aa85ea31e891)), closes [#93](https://github.com/peaceiris/actions-gh-pages/issues/93)
+* bump @types/node from 13.7.0 to 13.7.1 (#99) ([0b00dd2](https://github.com/peaceiris/actions-gh-pages/commit/0b00dd2a9f91c1854f4b1cfe68dc30891ebccc9f)), closes [#99](https://github.com/peaceiris/actions-gh-pages/issues/99)
+* bump @types/node from 13.7.1 to 13.7.2 (#110) ([591c4bd](https://github.com/peaceiris/actions-gh-pages/commit/591c4bdf2ee1c6aa5f1958c4553902feac06dcfe)), closes [#110](https://github.com/peaceiris/actions-gh-pages/issues/110)
+* bump @typescript-eslint/eslint-plugin from 2.19.0 to 2.19.2 (#97) ([5d5e933](https://github.com/peaceiris/actions-gh-pages/commit/5d5e9338ccbca63f80f5ee66ba9e9eff14bacb68)), closes [#97](https://github.com/peaceiris/actions-gh-pages/issues/97)
+* bump @typescript-eslint/eslint-plugin from 2.19.2 to 2.20.0 (#105) ([1c50baa](https://github.com/peaceiris/actions-gh-pages/commit/1c50baa294d259f81459f7a495f8d0d2a50a1b6d)), closes [#105](https://github.com/peaceiris/actions-gh-pages/issues/105)
+* bump @typescript-eslint/parser from 2.19.0 to 2.19.2 (#96) ([8b52b41](https://github.com/peaceiris/actions-gh-pages/commit/8b52b41ecb191f50bd5efc9ee2c0266a2d171d14)), closes [#96](https://github.com/peaceiris/actions-gh-pages/issues/96)
+* bump @typescript-eslint/parser from 2.19.2 to 2.20.0 (#106) ([73c09c7](https://github.com/peaceiris/actions-gh-pages/commit/73c09c703e63c0b442ffa50624ace10eaa929280)), closes [#106](https://github.com/peaceiris/actions-gh-pages/issues/106)
+* bump eslint-plugin-jest from 23.6.0 to 23.7.0 (#95) ([0a1a581](https://github.com/peaceiris/actions-gh-pages/commit/0a1a58196ba5bf48e168475e0ac3898fbd3043e2)), closes [#95](https://github.com/peaceiris/actions-gh-pages/issues/95)
+* bump husky from 4.2.1 to 4.2.3 (#102) ([49a6939](https://github.com/peaceiris/actions-gh-pages/commit/49a6939dbb77d7656228cdc3bed6a99d5124a6b2)), closes [#102](https://github.com/peaceiris/actions-gh-pages/issues/102)
+* bump node from 12.14.1 to 12.15.0 (#94) ([0e542f9](https://github.com/peaceiris/actions-gh-pages/commit/0e542f9f9231c005e1a6363a33a69fdbde436085)), closes [#94](https://github.com/peaceiris/actions-gh-pages/issues/94)
+* Rollback @types/node 13 to 12 (#111) ([195ab80](https://github.com/peaceiris/actions-gh-pages/commit/195ab8005d4af142c40fd8e53a59783b697d75d9)), closes [#111](https://github.com/peaceiris/actions-gh-pages/issues/111)
+
+### docs
+
+* fix ([60c31d2](https://github.com/peaceiris/actions-gh-pages/commit/60c31d23a8a096624a3b9a0955a05ea9941dc140))
+* rename author to Maintainer ([4101589](https://github.com/peaceiris/actions-gh-pages/commit/41015898aad0abad9d0760bc576e4748e476d4f9))
+* update job name ([752214a](https://github.com/peaceiris/actions-gh-pages/commit/752214aa33756f6e097f908671681a13865a9991))
+* update publish_branch for v3 ([a7866b5](https://github.com/peaceiris/actions-gh-pages/commit/a7866b5bd3a121a460c8c39cb1c9d1586db6b231))
+* update status of github_token ([1887981](https://github.com/peaceiris/actions-gh-pages/commit/1887981f72e59b54f68febb4fa4786e7e153ef6d))
+
+### fix
+
+* Change final message ([476fa94](https://github.com/peaceiris/actions-gh-pages/commit/476fa94197aea4d3f74e5619ae77ebf966fd5fff))
+* Use onetime workdir name (#109) ([2f5ccc9](https://github.com/peaceiris/actions-gh-pages/commit/2f5ccc92dfcf8e85d9d3c19dc842a440380253bf)), closes [#109](https://github.com/peaceiris/actions-gh-pages/issues/109)
+
+### refactor
+
+* fix typo and remove useless function (#107) ([55a68e3](https://github.com/peaceiris/actions-gh-pages/commit/55a68e34ca406d99b5b2a4549d7ade5eeb03d860)), closes [#107](https://github.com/peaceiris/actions-gh-pages/issues/107)
+
+
+
+## [3.0.4-1](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.4-0...v3.0.4-1) (2020-02-19)
+
+
+### deps
+
+* bump @types/node from 13.7.1 to 13.7.2 (#110) ([591c4bd](https://github.com/peaceiris/actions-gh-pages/commit/591c4bdf2ee1c6aa5f1958c4553902feac06dcfe)), closes [#110](https://github.com/peaceiris/actions-gh-pages/issues/110)
+* Rollback @types/node 13 to 12 (#111) ([195ab80](https://github.com/peaceiris/actions-gh-pages/commit/195ab8005d4af142c40fd8e53a59783b697d75d9)), closes [#111](https://github.com/peaceiris/actions-gh-pages/issues/111)
+
+### fix
+
+* Add await ([0031179](https://github.com/peaceiris/actions-gh-pages/commit/00311793aa104bf99501373756461475b6752f16))
+* convert to string ([cbe4d56](https://github.com/peaceiris/actions-gh-pages/commit/cbe4d56fb8bd50d63919f783483f74c694a3dd9b))
+* use onetime workdir name ([0d912a1](https://github.com/peaceiris/actions-gh-pages/commit/0d912a1314ce9d77f29bc0c1fada559223dd5563))
+
+### refactor
+
+* Add info message ([8e6c12a](https://github.com/peaceiris/actions-gh-pages/commit/8e6c12a2b5f973c8736f831398d0fe7c980f1431))
+
+
+
+## [3.0.4-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.3...v3.0.4-0) (2020-02-18)
+
+
+### chore
+
+* Allow to release from not master ([3c7cd58](https://github.com/peaceiris/actions-gh-pages/commit/3c7cd587e403a76d6725a0e84796cf12a59752f3))
+
+### deps
+
+* bump @types/jest from 25.1.1 to 25.1.2 (#93) ([aec195e](https://github.com/peaceiris/actions-gh-pages/commit/aec195ebb4e984f62f48139a5e24aa85ea31e891)), closes [#93](https://github.com/peaceiris/actions-gh-pages/issues/93)
+* bump @types/node from 13.7.0 to 13.7.1 (#99) ([0b00dd2](https://github.com/peaceiris/actions-gh-pages/commit/0b00dd2a9f91c1854f4b1cfe68dc30891ebccc9f)), closes [#99](https://github.com/peaceiris/actions-gh-pages/issues/99)
+* bump @typescript-eslint/eslint-plugin from 2.19.0 to 2.19.2 (#97) ([5d5e933](https://github.com/peaceiris/actions-gh-pages/commit/5d5e9338ccbca63f80f5ee66ba9e9eff14bacb68)), closes [#97](https://github.com/peaceiris/actions-gh-pages/issues/97)
+* bump @typescript-eslint/eslint-plugin from 2.19.2 to 2.20.0 (#105) ([1c50baa](https://github.com/peaceiris/actions-gh-pages/commit/1c50baa294d259f81459f7a495f8d0d2a50a1b6d)), closes [#105](https://github.com/peaceiris/actions-gh-pages/issues/105)
+* bump @typescript-eslint/parser from 2.19.0 to 2.19.2 (#96) ([8b52b41](https://github.com/peaceiris/actions-gh-pages/commit/8b52b41ecb191f50bd5efc9ee2c0266a2d171d14)), closes [#96](https://github.com/peaceiris/actions-gh-pages/issues/96)
+* bump @typescript-eslint/parser from 2.19.2 to 2.20.0 (#106) ([73c09c7](https://github.com/peaceiris/actions-gh-pages/commit/73c09c703e63c0b442ffa50624ace10eaa929280)), closes [#106](https://github.com/peaceiris/actions-gh-pages/issues/106)
+* bump eslint-plugin-jest from 23.6.0 to 23.7.0 (#95) ([0a1a581](https://github.com/peaceiris/actions-gh-pages/commit/0a1a58196ba5bf48e168475e0ac3898fbd3043e2)), closes [#95](https://github.com/peaceiris/actions-gh-pages/issues/95)
+* bump husky from 4.2.1 to 4.2.3 (#102) ([49a6939](https://github.com/peaceiris/actions-gh-pages/commit/49a6939dbb77d7656228cdc3bed6a99d5124a6b2)), closes [#102](https://github.com/peaceiris/actions-gh-pages/issues/102)
+* bump node from 12.14.1 to 12.15.0 (#94) ([0e542f9](https://github.com/peaceiris/actions-gh-pages/commit/0e542f9f9231c005e1a6363a33a69fdbde436085)), closes [#94](https://github.com/peaceiris/actions-gh-pages/issues/94)
+
+### docs
+
+* fix ([60c31d2](https://github.com/peaceiris/actions-gh-pages/commit/60c31d23a8a096624a3b9a0955a05ea9941dc140))
+* rename author to Maintainer ([4101589](https://github.com/peaceiris/actions-gh-pages/commit/41015898aad0abad9d0760bc576e4748e476d4f9))
+* update job name ([752214a](https://github.com/peaceiris/actions-gh-pages/commit/752214aa33756f6e097f908671681a13865a9991))
+* update publish_branch for v3 ([a7866b5](https://github.com/peaceiris/actions-gh-pages/commit/a7866b5bd3a121a460c8c39cb1c9d1586db6b231))
+* update status of github_token ([1887981](https://github.com/peaceiris/actions-gh-pages/commit/1887981f72e59b54f68febb4fa4786e7e153ef6d))
+
+### fix
+
+* Add removing workDir at the end ([5ba5849](https://github.com/peaceiris/actions-gh-pages/commit/5ba5849ab229d5b6eecc1d13de82e71999961cdc))
+* Change final message ([476fa94](https://github.com/peaceiris/actions-gh-pages/commit/476fa94197aea4d3f74e5619ae77ebf966fd5fff))
+* tag fetching ([6595e02](https://github.com/peaceiris/actions-gh-pages/commit/6595e02d683d6ca8275d76e2818662da80ac685a))
+* tag fetching ([6fe5c9e](https://github.com/peaceiris/actions-gh-pages/commit/6fe5c9e76213b6d5bc542be649cbe0289e947ab6))
+
+### refactor
+
+* fix typo and remove useless function (#107) ([55a68e3](https://github.com/peaceiris/actions-gh-pages/commit/55a68e34ca406d99b5b2a4549d7ade5eeb03d860)), closes [#107](https://github.com/peaceiris/actions-gh-pages/issues/107)
+
+
+
+## [3.0.3](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.3-0...v3.0.3) (2020-02-06)
+
+
+### docs
+
+* update example of publish_branch ([2948e5e](https://github.com/peaceiris/actions-gh-pages/commit/2948e5eda85d99ffc20cda677353918ea9ea3f45))
+
+
+
+## [3.0.3-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.2...v3.0.3-0) (2020-02-06)
+
+
+### fix
+
+* Enable to create branch for first deployment (#92) ([1b6740c](https://github.com/peaceiris/actions-gh-pages/commit/1b6740cb30fc6a5a695a015144589862eb241b7d)), closes [#92](https://github.com/peaceiris/actions-gh-pages/issues/92)
+
+
+
+## [3.0.2](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.1...v3.0.2) (2020-02-05)
+
+
+### ci
+
+* use github_token for windows-latest ([cfdf8c4](https://github.com/peaceiris/actions-gh-pages/commit/cfdf8c43ed170ce3bcfc1b4ee5ba50000e89f9e7))
+
+### docs
+
+* Add CodeFactor badge ([0ba5bf3](https://github.com/peaceiris/actions-gh-pages/commit/0ba5bf3eeb5f0ad9e42dc6344afa736b47dac67f))
+* Add Supported Platforms table ([f0177d1](https://github.com/peaceiris/actions-gh-pages/commit/f0177d176f9464c11cbdff5a68dbecd6e630e371))
+* update log example for v3 ([d35854b](https://github.com/peaceiris/actions-gh-pages/commit/d35854bdf87ba4311c5b5ba738260e4eb89c2295))
+
+### fix
+
+* add debug ([fb54d6a](https://github.com/peaceiris/actions-gh-pages/commit/fb54d6af4d2abbf7a42806620594b173c2f55882))
+* add filePath ([f8b5a36](https://github.com/peaceiris/actions-gh-pages/commit/f8b5a36401de48c3bf2fda47a51b010350405163))
+* copy directories #89 ([6edc4c9](https://github.com/peaceiris/actions-gh-pages/commit/6edc4c976449147551137b19eb7bc092d9d129ec)), closes [#89](https://github.com/peaceiris/actions-gh-pages/issues/89)
+* copy force ([848165c](https://github.com/peaceiris/actions-gh-pages/commit/848165cf9f01c61b1f2e83d433177a9f46ce5ea7))
+
+
+
+## [3.0.1](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.0...v3.0.1) (2020-02-05)
+
+
+### docs
+
+* Add link to v2 ([ec95e8e](https://github.com/peaceiris/actions-gh-pages/commit/ec95e8e7aae2075200c33461a0f3aa640d7fbe02))
+* remove Script mode section ([9b3fcdf](https://github.com/peaceiris/actions-gh-pages/commit/9b3fcdf51572449ce5f346724d01e878bd811834))
+* remove v2 example ([a1375a4](https://github.com/peaceiris/actions-gh-pages/commit/a1375a463794f123e06ddb6af0d74ef453d74fa0))
+* update ([1a26eac](https://github.com/peaceiris/actions-gh-pages/commit/1a26eaca33cf4f1d162fc37fd45cab6ea999140e))
+* update for v3 ([1a13108](https://github.com/peaceiris/actions-gh-pages/commit/1a1310886515195d8b9052e68aec5a973dd3779d))
+* update for v3 ([d0de38a](https://github.com/peaceiris/actions-gh-pages/commit/d0de38a352de7896c0bc618c3977f00f6a34151d))
+* update for v3 ([b3cfcb1](https://github.com/peaceiris/actions-gh-pages/commit/b3cfcb13c0e3d5b76fb2b306fafbc0bfdc349e2e))
+* update for v3 ([b1aaa85](https://github.com/peaceiris/actions-gh-pages/commit/b1aaa85b6766b71fd96a06d1ea8a99a5247e7b6c))
+* update for v3 ([f1e7cd6](https://github.com/peaceiris/actions-gh-pages/commit/f1e7cd608c631ec6a3c48e1e76f17b6c8a468ada))
+* update for v3 ([07a3f29](https://github.com/peaceiris/actions-gh-pages/commit/07a3f2915ef742feb191caf4315f92c5dbe24657))
+* update for v3 ([02c3858](https://github.com/peaceiris/actions-gh-pages/commit/02c38586a5b45e217af006473aa99749917bce73))
+* update for v3 ([59bbb98](https://github.com/peaceiris/actions-gh-pages/commit/59bbb98387fa6cde2495176555efd39a3c68b6b5))
+* update for v3 ([be27dcc](https://github.com/peaceiris/actions-gh-pages/commit/be27dcce4894bf0847e64b2ba676b9de08979d21))
+* update for v3 ([ccf71d1](https://github.com/peaceiris/actions-gh-pages/commit/ccf71d1162ce030d5f8aa4bb1e05c45d83912c67))
+* update for v3 ([5fe4aa3](https://github.com/peaceiris/actions-gh-pages/commit/5fe4aa3f24fd2a3f7cf683b04c29895c6882c5de))
+* update for v3 ([428902c](https://github.com/peaceiris/actions-gh-pages/commit/428902c6cd381168d113898fa3fd53e83ca658b2))
+* update for v3 ([00bca7b](https://github.com/peaceiris/actions-gh-pages/commit/00bca7b88cea3a6aff0cd9e90cc297f90981dfe8))
+* update GitHub Actions badge ([9cec798](https://github.com/peaceiris/actions-gh-pages/commit/9cec79845182679864d2e9f2b137c1829773b4a0))
+* update overview ([c940278](https://github.com/peaceiris/actions-gh-pages/commit/c940278a4c780afbd658b4a3f0f7834039913401))
+
+### feat
+
+* Add getHomeDir() for windows (#86) ([ed21b6a](https://github.com/peaceiris/actions-gh-pages/commit/ed21b6a5942b1be9f75103a2661d908d41ed9ea9)), closes [#86](https://github.com/peaceiris/actions-gh-pages/issues/86)
+
+### refactor
+
+* change to core.debug ([9f11da8](https://github.com/peaceiris/actions-gh-pages/commit/9f11da81ae3ead3c8929c35266dd40a0ddfd2bd1))
+
+
+
+# [3.0.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.0-1...v3.0.0) (2020-02-05)
+
+
+### ci
+
+* force_orphan to false ([a150e4e](https://github.com/peaceiris/actions-gh-pages/commit/a150e4e690ab9bfcecae05b68c8efd14edac15df))
+
+### fix
+
+* action title ([0629bab](https://github.com/peaceiris/actions-gh-pages/commit/0629babb090ceea68f118101b903a8e6798b2962))
+
+
+
+# [3.0.0-1](https://github.com/peaceiris/actions-gh-pages/compare/v2.10.1...v3.0.0-1) (2020-02-05)
+
+
+### chore
+
+* Change update_schedule from weekly to daily ([d3edcde](https://github.com/peaceiris/actions-gh-pages/commit/d3edcde28b32bdc18b358182c89a7a729facf37c))
+
+### docs
+
+* [ImgBot] Optimize images (#81) ([d82725c](https://github.com/peaceiris/actions-gh-pages/commit/d82725c632d7b9dd0fac1981cfaf13d4c550d682)), closes [#81](https://github.com/peaceiris/actions-gh-pages/issues/81)
+* Add Dart Package peanut for Flutter ([28b05fd](https://github.com/peaceiris/actions-gh-pages/commit/28b05fd3fab1ac4edb3d12ae0cbdc91367279667))
+* add Dependabot badge ([bacf0a6](https://github.com/peaceiris/actions-gh-pages/commit/bacf0a61ea8e93bcbbbd20089f87f8c12af605e2))
+* Add release feed badge ([2573b61](https://github.com/peaceiris/actions-gh-pages/commit/2573b6139ba429078ddf457eb170b4af924c55a4))
+* fix list ([96360d5](https://github.com/peaceiris/actions-gh-pages/commit/96360d5a85f6f54d3fb5175c158179b57a0149cc))
+* Update OGP image ([e504bd5](https://github.com/peaceiris/actions-gh-pages/commit/e504bd5c3862941f5d03ce8d649329e9d5e105aa))
+* update support table about GITHUB_TOKEN ([14069e7](https://github.com/peaceiris/actions-gh-pages/commit/14069e75e2e9646aeed42fedb5b99aa31ead3b90))
+
+### feat
+
+* Add TypeScript Action (#83) ([68b21c1](https://github.com/peaceiris/actions-gh-pages/commit/68b21c12af25bc606f77a7b5674f162f3a17bf22)), closes [#83](https://github.com/peaceiris/actions-gh-pages/issues/83) [#54](https://github.com/peaceiris/actions-gh-pages/issues/54)

Dockerfile

@@ -1,10 +1,30 @@
-FROM alpine:3.10.3
+ARG NODE_VERSION
 
-RUN apk add --no-cache \
-    bash \
-    git \
-    openssh-client \
-    ca-certificates
+FROM node:${NODE_VERSION}-buster-slim
 
-COPY entrypoint.sh /entrypoint.sh
-ENTRYPOINT [ "/entrypoint.sh" ]
+SHELL ["/bin/bash", "-l", "-c"]
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    build-essential \
+    libcurl4-gnutls-dev libexpat1-dev gettext libz-dev libssl-dev autoconf \
+    ca-certificates \
+    wget \
+    ssh \
+    vim && \
+    rm -rf /var/lib/apt/lists/*
+
+WORKDIR /git
+ENV GIT_VERSION="2.25.0"
+RUN wget -q "https://github.com/git/git/archive/v${GIT_VERSION}.tar.gz" && \
+    tar -zxf "./v${GIT_VERSION}.tar.gz" && \
+    rm "./v${GIT_VERSION}.tar.gz" && \
+    cd "./git-${GIT_VERSION}" && \
+    make configure && \
+    ./configure --prefix=/usr && \
+    make all && \
+    make install
+
+WORKDIR /repo
+
+CMD [ "bash" ]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Shohei Ueda (peaceiris)
+Copyright (c) 2020 Shohei Ueda (peaceiris)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,23 @@
+cmd := "bash"
+msg := ""
+IMAGE_NAME := actions_github_pages_dev:latest
+NODE_VERSION := $(shell cat ./.nvmrc)
+DOCKER_BUILD := docker build . -t $(IMAGE_NAME) --build-arg NODE_VERSION=$(NODE_VERSION)
+DOCKER_RUN := docker run --rm -i -t -v ${PWD}:/repo -v ~/.gitconfig:/root/.gitconfig $(IMAGE_NAME)
+
+
+.PHONY: build
+build:
+	$(DOCKER_BUILD)
+
+.PHONY: run
+run:
+	$(DOCKER_RUN) $(cmd)
+
+.PHONY: test
+test:
+	$(DOCKER_RUN) npm test
+
+.PHONY: commit
+commit:
+	$(DOCKER_RUN) git commit -m "$(msg)"

README.md

@@ -1,30 +1,60 @@
 [![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)
-[![Docker Hub Build Status](https://img.shields.io/docker/cloud/build/peaceiris/gh-pages.svg)](https://hub.docker.com/r/peaceiris/gh-pages)
+![Test Action](https://github.com/peaceiris/actions-gh-pages/workflows/Test%20Action/badge.svg?branch=master&event=push)
+[![CodeFactor](https://www.codefactor.io/repository/github/peaceiris/actions-gh-pages/badge)](https://www.codefactor.io/repository/github/peaceiris/actions-gh-pages)
+[![Release Feed](https://img.shields.io/badge/release-feed-yellow)](https://github.com/peaceiris/actions-gh-pages/releases.atom)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=peaceiris/actions-gh-pages)](https://dependabot.com)
 
 <img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="./images/ogp.svg">
 
+> This Action has been migrated to a TypeScript Action (version 3).
+>
+> The old Docker Action is [peaceiris/actions-gh-pages@v2](https://github.com/peaceiris/actions-gh-pages/tree/v2)
+
 
 
 ## GitHub Actions for GitHub Pages
 
 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.)
+This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, mdBook, etc.)
 
 [Static Site Generators]: https://www.staticgen.com/
 
+The next example step will deploy `./public` directory to the remote `gh-pages` branch.
+
+
 ```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
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    # github_token: ${{ secrets.GITHUB_TOKEN }}
+    # personal_token: ${{ secrets.PERSONAL_TOKEN }}
+    publish_dir: ./public
 ```
 
-The above example step will deploy `./public` directory to `gh-pages` branch.
+### Supported Tokens
+
+Three tokens are supported.
+
+| Token | Private repo | Public repo | Protocol | Setup |
+|---|:---:|:---:|---|---|
+| `github_token` | ✅️ | (1) | HTTPS | Unnecessary |
+| `personal_token` | ✅️ | ✅️ | HTTPS | Necessary |
+| `deploy_key` | ✅️ | ✅️ | SSH | Necessary |
+
+1. ~~Currently, GitHub Actions does not support to trigger a GitHub Pages build event using GITHUB_TOKEN on a public repository.~~ Maybe, we can use it but there is no official announcement by GitHub.
+
+### Supported Platforms
+
+| runs-on | `deploy_key` | `github_token` | `personal_token` |
+|---|:---:|:---:|:---:|
+| ubuntu-18.04 | ✅️ | ✅️ | ✅️ |
+| macos-latest | ✅️ | ✅️ | ✅️ |
+| windows-latest | (2) | ✅️ | ✅️ |
+
+2. WIP, See [Issue #87](https://github.com/peaceiris/actions-gh-pages/issues/87)
 
 
 
@@ -40,13 +70,17 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
     - [⭐️ 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)
+  - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
+  - [⭐️ `github_token`](#%EF%B8%8F-github_token)
+  - [⭐️ CNAME](#%EF%B8%8F-cname)
+  - [⭐️ Disable `.nojekyll`](#%EF%B8%8F-disable-nojekyll)
+  - [⭐️ Allow empty commits](#%EF%B8%8F-allow-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)
+  - [⭐️ Force orphan](#%EF%B8%8F-force-orphan)
+  - [⭐️ Set Git username and email](#%EF%B8%8F-set-git-username-and-email)
+  - [⭐️ Set custom commit message](#%EF%B8%8F-set-custom-commit-message)
+  - [⭐️ Create Git tag](#%EF%B8%8F-create-git-tag)
 - [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)
@@ -57,8 +91,11 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
   - [⭐️ React and Next](#%EF%B8%8F-react-and-next)
   - [⭐️ Vue and Nuxt](#%EF%B8%8F-vue-and-nuxt)
   - [⭐️ Static Site Generators with Python](#%EF%B8%8F-static-site-generators-with-python)
+  - [⭐️ mdBook (Rust)](#%EF%B8%8F-mdbook-rust)
+  - [⭐️ Flutter Web](#%EF%B8%8F-flutter-web)
+  - [⭐️ Elm](#%EF%B8%8F-elm)
 - [License](#license)
-- [About the author](#about-the-author)
+- [Maintainer](#maintainer)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -111,30 +148,29 @@ name: github pages
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
-      # with:
-      #   submodules: true
+      - uses: actions/checkout@v1
+        # with:
+        #   submodules: true
 
-    - name: Setup Hugo
-      uses: peaceiris/actions-hugo@v2.2.2
-      with:
-        hugo-version: '0.58.3'
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.64.0'
 
-    - name: Build
-      run: hugo --minify
+      - name: Build
+        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
-        PUBLISH_DIR: ./public
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
@@ -150,21 +186,37 @@ The above example is for [Project Pages sites]. (`<username>/<project_name>` rep
 #### ⭐️ 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`.
+we have to set `master` branch to `publish_branch`.
+
+A default value of `publish_branch` is `gh-pages`.
 
 ```yaml
 on:
   push:
     branches:
-    - source  # default branch
+      - source  # default branch
 
-PUBLISH_BRANCH: master  # deploying branch
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - run: somebuild
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
+          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)
+![Change default branch](./images/user_repo.jpg)
 
 <div align="right">
 <a href="#table-of-contents">Back to TOC ☝️</a>
@@ -174,117 +226,204 @@ PUBLISH_BRANCH: master  # deploying branch
 
 ## 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.5.0
-+ uses: docker://peaceiris/gh-pages:v2.5.0
-```
-
-- [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
-
-### ⭐️ `PERSONAL_TOKEN`
+### ⭐️ `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
-- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-+ PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
++ personal_token: ${{ secrets.PERSONAL_TOKEN }}
 ```
 
-### ⭐️ `GITHUB_TOKEN`
+### ⭐️ `github_token`
 
-> ⚠️ **NOTES**: `GITHUB_TOKEN` works only on a **private** repository.
+> ⚠️ **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 }}
+- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
++ github_token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-### ⭐️ Suppressing empty commits
+### ⭐️ CNAME
 
-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]
+To add `CNAME` file, we can set the `cname` option.
 
-[Issue #21]: https://github.com/peaceiris/actions-gh-pages/issues/21
+For more details about `CNAME`, read the official documentation: [Managing a custom domain for your GitHub Pages site - GitHub Help](https://help.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site)
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    cname: github.com
+```
+
+### ⭐️ Disable `.nojekyll`
+
+By default, this action adds the `.nojekyll` file to only the `master` and `gh-pages` branches. When the file already exists, this action does nothing.
+
+To disable this behavior, we can set the `disable_nojekyll` option to `true`.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    disable_nojekyll: true
+```
+
+### ⭐️ Allow empty commits
+
+By default, a commit will not be generated when no file changes. If you want to allow an empty commit, set the optional parameter `allow_empty_commit` 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
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    emptyCommits: false
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    allow_empty_commit: true
 ```
 
 ### ⭐️ 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`.
+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 `keep_files` 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
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    keepFiles: true
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    keep_files: 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`.
+If you want to publish to another repository on GitHub, set the environment variable `external_repository` to `<username>/<external-repository>`.
 
 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
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    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.
+You can use `deploy_key` or `personal_token`.
+When you use `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
+### ⭐️ Force orphan
 
-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`
+We can set the `force_orphan: true` option.
+This allows you to make your publish branch with only the latest commit.
 
 ```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
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    force_orphan: true
+```
+
+### ⭐️ Set Git username and email
+
+Set custom `git config user.name` and `git config user.email`.
+A commit is always created with the same user.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    user_name: iris
+    user_email: iris@peaceiris.com
+```
+
+### ⭐️ Set custom commit message
+
+Set custom commit message.
+When we create a commit with a message `docs: Update some post`, a deployment commit will be generated with a message `docs: Update some post ${GITHUB_SHA}`.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    commit_message: ${{ github.event.head_commit.message }}
+```
+
+### ⭐️ Create Git tag
+
+Here is an example workflow.
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Some build
+
+      - name: Prepare tag
+        id: prepare_tag
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          TAG_NAME="${GITHUB_REF##refs/tags/}"
+          echo "::set-output name=tag_name::${TAG_NAME}"
+          echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
+          tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
+          tag_message: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'
+```
+
+Commands on a local machine.
+
+```console
+$ # On the master branch
+$ git tag -a "v1.2.3" -m "Release v1.2.3"
+$ git push origin "v1.2.3"
+
+$ # After deployment
+$ git fetch origin
+$ git tag
+deploy-v1.2.3  # Tag on the gh-pages branch
+v1.2.3         # Tag on the master branch
 ```
 
 <div align="right">
@@ -324,9 +463,9 @@ Does not your static site generator deal with the static files? No problem, you
 
 ### ⭐️ 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.)
+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`.
+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/)
 
@@ -371,28 +510,36 @@ name: github pages
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
-    - name: build
-      uses: actions/setup-node@v1
-      with:
-        node-version: '10.x'
-    - run: |
-        npm install
-        npm run build
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
 
-    - 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
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - run: npm ci
+
+      - run: npm run build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 ### ⭐️ Gatsby
@@ -410,37 +557,40 @@ name: github pages
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
-    - name: setup node
-      uses: actions/setup-node@v1
-      with:
-        node-version: '10.x'
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
 
-    - name: install
-      run: npm install
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
 
-    - name: format
-      run: npm run format
+      - run: npm ci
 
-    - name: test
-      run: npm run test
+      - run: npm run format
 
-    - name: build
-      run: npm run build
+      - run: npm run test
 
-    - 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
+      - run: npm run build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 ### ⭐️ React and Next
@@ -460,37 +610,44 @@ name: github pages
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
-    - name: setup node
-      uses: actions/setup-node@v1
-      with:
-        node-version: '10.x'
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
 
-    - name: install
-      run: yarn install
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
 
-    - name: build
-      run: yarn build
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
 
-    - name: export
-      run: yarn export
+      - run: yarn install
 
-    - name: add nojekyll
-      run: touch ./out/.nojekyll
+      - run: yarn build
 
-    - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.5.0
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./out
+      - run: yarn export
+
+      - run: touch ./out/.nojekyll
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./out
 ```
 
 ### ⭐️ Vue and Nuxt
@@ -510,34 +667,38 @@ name: github pages
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
-    - name: setup node
-      uses: actions/setup-node@v1
-      with:
-        node-version: '10.x'
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
 
-    - name: install
-      run: npm install
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
 
-    - name: test
-      run: npm test
+      - run: npm ci
 
-    - name: generate
-      run: npm run generate
+      - run: npm test
 
-    - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.5.0
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./dist
+      - run: npm run generate
+
+      - name: deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./dist
 ```
 
 ### ⭐️ Static Site Generators with Python
@@ -558,37 +719,165 @@ name: github pages
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
-    - name: Set up Python
-      uses: actions/setup-python@v1
-      with:
-        python-version: '3.6'
-        architecture: 'x64'
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.6'
+          architecture: 'x64'
 
-    - name: Install dependencies
-      run: |
-        pip install --upgrade pip
-        pip install -r ./requirements.txt
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
 
-    - name: Build
-      run: mkdocs build
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install -r ./requirements.txt
 
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2.5.0
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./site
+      - run: mkdocs build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./site
 ```
 
+### ⭐️ mdBook (Rust)
 
+An example GitHub Actions workflow to deploy [rust-lang/mdBook] site to GitHub Pages.
+
+[rust-lang/mdBook]: https://github.com/rust-lang/mdBook
+
+- [peaceiris/actions-mdbook: GitHub Actions for mdBook (rust-lang/mdBook)](https://github.com/peaceiris/actions-mdbook)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.3.5'
+          # mdbook-version: 'latest'
+
+      - run: mdbook build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./book
+```
+
+### ⭐️ Flutter Web
+
+An exapmle workflow for [Flutter web project].
+Setup [Flutter] with [subosito/flutter-action].
+
+[peanut | Dart Package] is also useful.
+
+[Flutter]: https://github.com/flutter/flutter
+[Flutter web project]: https://flutter.dev/docs/get-started/web
+[subosito/flutter-action]: https://github.com/subosito/flutter-action
+[peanut | Dart Package]: https://pub.dev/packages/peanut
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v1
+        with:
+          channel: 'beta'
+
+      - name: Install
+        run: |
+          flutter config --enable-web
+          flutter pub get
+
+      - name: Build
+        run: flutter build web
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./build/web
+```
+
+### ⭐️ Elm
+
+An exapmle workflow for [Elm] with [justgook/setup-elm].
+
+[Elm]: https://elm-lang.org
+[justgook/setup-elm]: https://github.com/justgook/setup-elm
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Elm
+        uses: justgook/setup-elm@v1
+
+      - name: Make
+        run: elm make --optimize src/Main.elm
+
+      - name: Move files
+        run: |
+          mkdir ./public
+          mv ./index.html ./public/
+        # If you have non-minimal setup with some assets and separate html/js files,
+        # provide --output=<output-file> option for `elm make` and remove this step
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
+```
 
 ## License
 
@@ -598,9 +887,9 @@ jobs:
 
 
 
-## About the author
+## Maintainer
 
-- [peaceiris's homepage](https://peaceiris.com/)
+- [peaceiris homepage](https://peaceiris.com/)
 
 
 

__tests__/get-inputs.test.ts

@@ -0,0 +1,93 @@
+// import * as main from '../src/main';
+import {Inputs} from '../src/interfaces';
+import {getInputs} from '../src/get-inputs';
+
+beforeEach(() => {
+  jest.resetModules();
+});
+
+afterEach(() => {
+  delete process.env['INPUT_DEPLOY_KEY'];
+  delete process.env['INPUT_GITHUB_TOKEN'];
+  delete process.env['INPUT_PERSONAL_TOKEN'];
+  delete process.env['INPUT_PUBLISH_BRANCH'];
+  delete process.env['INPUT_PUBLISH_DIR'];
+  delete process.env['INPUT_EXTERNAL_REPOSITORY'];
+  delete process.env['INPUT_ALLOW_EMPTY_COMMIT'];
+  delete process.env['INPUT_KEEP_FILES'];
+  delete process.env['INPUT_FORCE_ORPHAN'];
+  delete process.env['INPUT_USER_NAME'];
+  delete process.env['INPUT_USER_EMAIL'];
+  delete process.env['INPUT_COMMIT_MESSAGE'];
+  delete process.env['INPUT_TAG_NAME'];
+  delete process.env['INPUT_TAG_MESSAGE'];
+  delete process.env['INPUT_DISABLE_NOJEKYLL'];
+  delete process.env['INPUT_CNAME'];
+});
+
+describe('getInputs()', () => {
+  test('get default inputs', () => {
+    process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
+    // process.env['INPUT_GITHUB_TOKEN'] = 'test_github_token';
+    // process.env['INPUT_PERSONAL_TOKEN'] = 'test_personal_token';
+    process.env['INPUT_PUBLISH_BRANCH'] = 'gh-pages';
+    process.env['INPUT_PUBLISH_DIR'] = 'public';
+
+    const inps: Inputs = getInputs();
+
+    expect(inps.DeployKey).toMatch('test_deploy_key');
+    expect(inps.GithubToken).toMatch('');
+    expect(inps.PersonalToken).toMatch('');
+    expect(inps.PublishBranch).toMatch('gh-pages');
+    expect(inps.PublishDir).toMatch('public');
+    expect(inps.ExternalRepository).toMatch('');
+    expect(inps.AllowEmptyCommit).toBe(false);
+    expect(inps.KeepFiles).toBe(false);
+    expect(inps.ForceOrphan).toBe(false);
+    expect(inps.UserName).toMatch('');
+    expect(inps.UserEmail).toMatch('');
+    expect(inps.CommitMessage).toMatch('');
+    expect(inps.TagName).toMatch('');
+    expect(inps.TagMessage).toMatch('');
+    expect(inps.DisableNoJekyll).toBe(false);
+    expect(inps.CNAME).toMatch('');
+  });
+
+  test('get spec inputs', () => {
+    // process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
+    process.env['INPUT_GITHUB_TOKEN'] = 'test_github_token';
+    process.env['INPUT_PERSONAL_TOKEN'] = 'test_personal_token';
+    process.env['INPUT_PUBLISH_BRANCH'] = 'master';
+    process.env['INPUT_PUBLISH_DIR'] = 'out';
+    process.env['INPUT_EXTERNAL_REPOSITORY'] = 'user/repo';
+    process.env['INPUT_ALLOW_EMPTY_COMMIT'] = 'true';
+    process.env['INPUT_KEEP_FILES'] = 'true';
+    process.env['INPUT_FORCE_ORPHAN'] = 'true';
+    process.env['INPUT_USER_NAME'] = 'username';
+    process.env['INPUT_USER_EMAIL'] = 'github@github.com';
+    process.env['INPUT_COMMIT_MESSAGE'] = 'feat: Add new feature';
+    process.env['INPUT_TAG_NAME'] = 'deploy-v1.2.3';
+    process.env['INPUT_TAG_MESSAGE'] = 'Deployment v1.2.3';
+    process.env['INPUT_DISABLE_NOJEKYLL'] = 'true';
+    process.env['INPUT_CNAME'] = 'github.com';
+
+    const inps: Inputs = getInputs();
+
+    expect(inps.DeployKey).toMatch('');
+    expect(inps.GithubToken).toMatch('test_github_token');
+    expect(inps.PersonalToken).toMatch('test_personal_token');
+    expect(inps.PublishBranch).toMatch('master');
+    expect(inps.PublishDir).toMatch('out');
+    expect(inps.ExternalRepository).toMatch('user/repo');
+    expect(inps.AllowEmptyCommit).toBe(true);
+    expect(inps.KeepFiles).toBe(true);
+    expect(inps.ForceOrphan).toBe(true);
+    expect(inps.UserName).toMatch('username');
+    expect(inps.UserEmail).toMatch('github@github.com');
+    expect(inps.CommitMessage).toMatch('feat: Add new feature');
+    expect(inps.TagName).toMatch('deploy-v1.2.3');
+    expect(inps.TagMessage).toMatch('Deployment v1.2.3');
+    expect(inps.DisableNoJekyll).toBe(true);
+    expect(inps.CNAME).toMatch('github.com');
+  });
+});

__tests__/main.test.ts

@@ -0,0 +1,32 @@
+// import {run} from '../src/main';
+
+beforeEach(() => {
+  jest.resetModules();
+});
+
+afterEach(() => {
+  delete process.env['INPUT_DEPLOY_KEY'];
+  delete process.env['INPUT_GITHUB_TOKEN'];
+  delete process.env['INPUT_PERSONAL_TOKEN'];
+  delete process.env['INPUT_PUBLISH_BRANCH'];
+  delete process.env['INPUT_PUBLISH_DIR'];
+  delete process.env['INPUT_EXTERNAL_REPOSITORY'];
+  delete process.env['INPUT_ALLOW_EMPTY_COMMIT'];
+  delete process.env['INPUT_KEEP_FILES'];
+  delete process.env['INPUT_FORCE_ORPHAN'];
+  delete process.env['INPUT_USER_NAME'];
+  delete process.env['INPUT_USER_EMAIL'];
+  delete process.env['INPUT_COMMIT_MESSAGE'];
+  delete process.env['INPUT_TAG_NAME'];
+  delete process.env['INPUT_TAG_MESSAGE'];
+  delete process.env['INPUT_TAG_OVERWRITE'];
+});
+
+describe('Integration testing run()', () => {
+  test('succeed in pushing using deploy key', async () => {
+    // process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
+    // process.env['GITHUB_REPOSITORY'] = 'owner/repo';
+    // const exitcode = await run();
+    expect(0).toBe(0);
+  });
+});

__tests__/utils.test.ts

@@ -0,0 +1,190 @@
+import path from 'path';
+import fs from 'fs';
+import {
+  getHomeDir,
+  getWorkDirName,
+  createWorkDir,
+  addNoJekyll,
+  addCNAME
+} from '../src/utils';
+
+beforeEach(() => {
+  jest.resetModules();
+});
+
+// afterEach(() => {
+
+// });
+
+async function getTime(): Promise<string> {
+  const date = new Date();
+  const unixTime = date.getTime();
+  return `${unixTime}`;
+}
+
+describe('getHomeDir()', () => {
+  test('get home directory name', async () => {
+    let test = '';
+    if (process.platform === 'win32') {
+      test = 'C:\\Users\\runneradmin';
+    } else {
+      test = `${process.env.HOME}`;
+    }
+    const expected = await getHomeDir();
+    expect(test).toMatch(expected);
+  });
+});
+
+describe('getWorkDirName()', () => {
+  test('get work directory name', async () => {
+    let home = '';
+    if (process.platform === 'win32') {
+      home = 'C:\\Users\\runneradmin';
+    } else {
+      home = `${process.env.HOME}`;
+    }
+    const unixTime = await getTime();
+    const expected = path.join(home, `actions_github_pages_${unixTime}`);
+    const test = await getWorkDirName(`${unixTime}`);
+    expect(test).toMatch(expected);
+  });
+});
+
+describe('createWorkDir()', () => {
+  test('create work directory', async () => {
+    const unixTime = await getTime();
+    const workDirName = await getWorkDirName(`${unixTime}`);
+    await createWorkDir(workDirName);
+    const test = fs.existsSync(workDirName);
+    expect(test).toBe(true);
+  });
+});
+
+async function getWorkDir(): Promise<string> {
+  const unixTime = await getTime();
+  let workDir = '';
+  workDir = await getWorkDirName(`${unixTime}`);
+  await createWorkDir(workDir);
+  return workDir;
+}
+
+describe('addNoJekyll()', () => {
+  test('add .nojekyll gh-pages', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+
+    await addNoJekyll(workDir, false, 'gh-pages');
+    const test1 = fs.existsSync(filepath);
+    expect(test1).toBe(true);
+
+    fs.unlinkSync(filepath);
+  });
+
+  test('add .nojekyll master', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+
+    await addNoJekyll(workDir, false, 'master');
+    const test2 = fs.existsSync(filepath);
+    expect(test2).toBe(true);
+
+    fs.unlinkSync(filepath);
+  });
+
+  test('not add .nojekyll disable_nojekyll gh-pages', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+
+    await addNoJekyll(workDir, true, 'gh-pages');
+    const test3 = fs.existsSync(filepath);
+    expect(test3).toBe(false);
+  });
+
+  test('not add .nojekyll disable_nojekyll master', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+
+    await addNoJekyll(workDir, true, 'master');
+    const test4 = fs.existsSync(filepath);
+    expect(test4).toBe(false);
+  });
+
+  test('not add .nojekyll other-branch', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+
+    await addNoJekyll(workDir, false, 'other-branch');
+    const test5 = fs.existsSync(filepath);
+    expect(test5).toBe(false);
+  });
+
+  test('not add .nojekyll disable_nojekyll other-branch', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+
+    await addNoJekyll(workDir, true, 'other-branch');
+    const test6 = fs.existsSync(filepath);
+    expect(test6).toBe(false);
+  });
+});
+
+describe('addCNAME()', () => {
+  test('add CNAME', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, 'CNAME');
+
+    await addCNAME(workDir, 'github.com');
+    const test1 = fs.readFileSync(filepath, 'utf8');
+    expect(test1).toMatch('github.com');
+
+    fs.unlinkSync(filepath);
+  });
+
+  test('do nothing', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, 'CNAME');
+
+    await addCNAME(workDir, '');
+    const test2 = fs.existsSync(filepath);
+    expect(test2).toBe(false);
+  });
+
+  test('CNAME already exists', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, 'CNAME');
+
+    await addCNAME(workDir, 'github.io');
+    await addCNAME(workDir, 'github.com');
+    const test3 = fs.readFileSync(filepath, 'utf8');
+    expect(test3).toMatch('github.io');
+
+    fs.unlinkSync(filepath);
+  });
+});

action.yml

@@ -2,17 +2,63 @@ name: 'GitHub Pages action'
 description: 'GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.'
 author: 'peaceiris'
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: 'node12'
+  main: 'lib/index.js'
 branding:
   icon: 'upload-cloud'
   color: 'blue'
 inputs:
-  emptyCommits:
+  deploy_key:
+    description: ''
+    required: false
+  github_token:
+    description: ''
+    required: false
+  personal_token:
+    description: ''
+    required: false
+  publish_branch:
+    description: ''
+    required: false
+    default: 'gh-pages'
+  publish_dir:
+    description: ''
+    required: false
+    default: 'public'
+  external_repository:
+    description: ''
+    required: false
+  allow_empty_commit:
     description: 'If empty commits should be made to the publication branch'
     required: false
-    default: 'true'
-  keepFiles:
+    default: 'false'
+  keep_files:
     description: 'If existing files in the publish branch should be not removed before deploying'
     required: false
     default: 'false'
+  force_orphan:
+    description: 'Keep only the latest commit on a GitHub Pages branch'
+    required: false
+    default: 'false'
+  user_name:
+    description: 'Set Git user.name'
+    required: false
+  user_email:
+    description: 'Set Git user.email'
+    required: false
+  commit_message:
+    description: 'Set custom commit message'
+    required: false
+  tag_name:
+    description: 'Set tag name'
+    required: false
+  tag_message:
+    description: 'Set tag message'
+    required: false
+  disable_nojekyll:
+    description: 'Disable adding .nojekyll file to master or gh-pages branches'
+    required: false
+    default: 'false'
+  cname:
+    description: 'Set custom domain'
+    required: false

entrypoint.sh

@@ -1,114 +0,0 @@
-#!/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"
-}
-
-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"
-
-    if [ -n "${SCRIPT_MODE}" ]; then
-        print_info "run as SCRIPT_MODE"
-        SSH_DIR="${HOME}/.ssh"
-    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:${PUBLISH_REPOSITORY}.git"
-
-elif [ -n "${PERSONAL_TOKEN}" ]; then
-
-    print_info "setup with PERSONAL_TOKEN"
-
-    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"
-
-    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"
-    exit 1
-fi
-
-if [ -z "${PUBLISH_BRANCH}" ]; then
-    print_error "not found PUBLISH_BRANCH"
-    exit 1
-fi
-
-if [ -z "${PUBLISH_DIR}" ]; then
-    print_error "not found PUBLISH_DIR"
-    exit 1
-fi
-
-remote_branch="${PUBLISH_BRANCH}"
-
-local_dir="${HOME}/ghpages_${RANDOM}"
-if git clone --depth=1 --single-branch --branch "${remote_branch}" "${remote_repo}" "${local_dir}"; then
-    cd "${local_dir}"
-
-    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}/"
-else
-    cd "${PUBLISH_DIR}"
-    git init
-    git checkout --orphan "${remote_branch}"
-fi
-
-# push to publishing 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
-
-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"

jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  clearMocks: true,
+  moduleFileExtensions: ['js', 'ts'],
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testRunner: 'jest-circus/runner',
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  verbose: true
+}

package.json

@@ -0,0 +1,75 @@
+{
+  "name": "actions-github-pages",
+  "version": "3.3.0",
+  "description": "GitHub Actions for GitHub Pages",
+  "main": "lib/index.js",
+  "engines": {
+    "node": ">=12.14.1",
+    "npm": ">=6.13.7"
+  },
+  "scripts": {
+    "lint": "eslint ./{src,__tests__}/**/*.ts",
+    "lint:fix": "eslint --fix ./{src,__tests__}/**/*.ts",
+    "test": "jest --coverage --verbose --detectOpenHandles",
+    "build": "ncc build ./src/index.ts -o lib",
+    "tsc": "tsc",
+    "format": "prettier --write **/*.ts",
+    "format:check": "prettier --check **/*.ts",
+    "release": "standard-version",
+    "update-deps": "(git diff 'HEAD@{1}' --name-only | grep 'package-lock.json' > /dev/null) && npm ci || :"
+  },
+  "husky": {
+    "skipCI": true,
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "post-merge": "npm run update-deps; git remote prune origin"
+    }
+  },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "prettier --check",
+      "eslint"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peaceiris/actions-gh-pages.git"
+  },
+  "keywords": [
+    "GitHub Actions",
+    "Actions",
+    "JavaScript Action",
+    "TypeScript Action",
+    "GitHub Pages",
+    "gh-pages"
+  ],
+  "author": "peaceiris",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/peaceiris/actions-gh-pages/issues"
+  },
+  "homepage": "https://github.com/peaceiris/actions-gh-pages#readme",
+  "dependencies": {
+    "@actions/core": "^1.2.2",
+    "@actions/exec": "^1.0.3",
+    "@actions/github": "^2.1.1",
+    "@actions/io": "^1.0.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.1.3",
+    "@types/node": "~12",
+    "@typescript-eslint/eslint-plugin": "^2.20.0",
+    "@typescript-eslint/parser": "^2.20.0",
+    "@zeit/ncc": "^0.21.1",
+    "eslint": "^6.8.0",
+    "eslint-plugin-jest": "^23.7.0",
+    "husky": "^4.2.3",
+    "jest": "^25.1.0",
+    "jest-circus": "^25.1.0",
+    "lint-staged": "^10.0.7",
+    "prettier": "1.19.1",
+    "standard-version": "^7.1.0",
+    "ts-jest": "^25.2.1",
+    "typescript": "^3.8.2"
+  }
+}

release.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+# fail on unset variables and command errors
+set -eu -o pipefail # -x: is for debugging
+
+CURRENT_BRANCH="$(git branch --show-current)"
+if [ "${CURRENT_BRANCH}" != "master" ]; then
+  echo "$0: Current branch ${CURRENT_BRANCH} is not master, continue? (y/n)"
+  read -r res
+  if [ "${res}" = "n" ]; then
+    echo "$0: Stop script"
+    exit 0
+  fi
+fi
+
+PRERELEASE_TYPE_LIST="prerelease prepatch preminor premajor"
+if [ "${CURRENT_BRANCH}" != "master" ]; then
+  RELEASE_TYPE_LIST="${PRERELEASE_TYPE_LIST}"
+else
+  RELEASE_TYPE_LIST="${PRERELEASE_TYPE_LIST} patch minor major"
+fi
+
+if command -v fzf; then
+  RELEASE_TYPE=$(echo "${RELEASE_TYPE_LIST}" | tr ' ' '\n' | fzf --layout=reverse)
+else
+  select sel in ${RELEASE_TYPE_LIST}; do
+    RELEASE_TYPE="${sel}"
+    break
+  done
+fi
+
+echo "$0: Create ${RELEASE_TYPE} release, continue? (y/n)"
+read -r res
+if [ "${res}" = "n" ]; then
+  echo "$0: Stop script"
+  exit 0
+fi
+
+git fetch origin
+if [ "${CURRENT_BRANCH}" != "master" ]; then
+  git pull origin "${CURRENT_BRANCH}"
+else
+  git pull origin master
+  git tag -d v3 || true
+  git pull origin --tags
+fi
+
+npm ci
+
+mkdir ./lib
+npm run build
+git add ./lib/index.js
+git commit -m "chore(release): Add build assets"
+
+npm run release -- --release-as "${RELEASE_TYPE}" --preset eslint
+
+git rm ./lib/index.js
+rm -rf ./lib
+git commit -m "chore(release): Remove build assets [skip ci]"
+
+if [ "${CURRENT_BRANCH}" != "master" ]; then
+  git push origin "${CURRENT_BRANCH}"
+else
+  git push origin master
+fi
+
+TAG_NAME="v$(jq -r '.version' ./package.json)"
+git push origin "${TAG_NAME}"

src/get-inputs.ts

@@ -0,0 +1,55 @@
+import * as core from '@actions/core';
+import {Inputs} from './interfaces';
+
+function showInputs(inps: Inputs): void {
+  if (inps.DeployKey) {
+    core.info(`[INFO] DeployKey: true`);
+  } else if (inps.GithubToken) {
+    core.info(`[INFO] GithubToken: true`);
+  } else if (inps.PersonalToken) {
+    core.info(`[INFO] PersonalToken: true`);
+  }
+
+  core.info(`[INFO] PublishBranch: ${inps.PublishBranch}`);
+  core.info(`[INFO] PublishDir: ${inps.PublishDir}`);
+  core.info(`[INFO] ExternalRepository: ${inps.ExternalRepository}`);
+  core.info(`[INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}`);
+  core.info(`[INFO] KeepFiles: ${inps.KeepFiles}`);
+  core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
+  core.info(`[INFO] UserName: ${inps.UserName}`);
+  core.info(`[INFO] UserEmail: ${inps.UserEmail}`);
+  core.info(`[INFO] CommitMessage: ${inps.CommitMessage}`);
+  core.info(`[INFO] TagName: ${inps.TagName}`);
+  core.info(`[INFO] TagMessage: ${inps.TagMessage}`);
+  core.info(`[INFO] DisableNoJekyll: ${inps.DisableNoJekyll}`);
+  core.info(`[INFO] CNAME: ${inps.CNAME}`);
+}
+
+export function getInputs(): Inputs {
+  const inps: Inputs = {
+    DeployKey: core.getInput('deploy_key'),
+    GithubToken: core.getInput('github_token'),
+    PersonalToken: core.getInput('personal_token'),
+    PublishBranch: core.getInput('publish_branch'),
+    PublishDir: core.getInput('publish_dir'),
+    ExternalRepository: core.getInput('external_repository'),
+    AllowEmptyCommit:
+      (core.getInput('allow_empty_commit') || 'false').toUpperCase() === 'TRUE',
+    KeepFiles:
+      (core.getInput('keep_files') || 'false').toUpperCase() === 'TRUE',
+    ForceOrphan:
+      (core.getInput('force_orphan') || 'false').toUpperCase() === 'TRUE',
+    UserName: core.getInput('user_name'),
+    UserEmail: core.getInput('user_email'),
+    CommitMessage: core.getInput('commit_message'),
+    TagName: core.getInput('tag_name'),
+    TagMessage: core.getInput('tag_message'),
+    DisableNoJekyll:
+      (core.getInput('disable_nojekyll') || 'false').toUpperCase() === 'TRUE',
+    CNAME: core.getInput('cname')
+  };
+
+  showInputs(inps);
+
+  return inps;
+}

src/git-utils.ts

@@ -0,0 +1,191 @@
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import * as github from '@actions/github';
+import * as io from '@actions/io';
+import path from 'path';
+import fs from 'fs';
+import {Inputs, CmdResult} from './interfaces';
+import {createWorkDir} from './utils';
+
+export async function createBranchForce(branch: string): Promise<void> {
+  await exec.exec('git', ['init']);
+  await exec.exec('git', ['checkout', '--orphan', branch]);
+  return;
+}
+
+export async function copyAssets(
+  publishDir: string,
+  workDir: string
+): Promise<void> {
+  const copyOpts = {recursive: true, force: true};
+  const files = fs.readdirSync(publishDir);
+  core.debug(`${files}`);
+  for await (const file of files) {
+    if (file.endsWith('.git') || file.endsWith('.github')) {
+      continue;
+    }
+    const filePath = path.join(publishDir, file);
+    await io.cp(filePath, `${workDir}/`, copyOpts);
+    core.info(`[INFO] copy ${file}`);
+  }
+
+  return;
+}
+
+export async function setRepo(
+  inps: Inputs,
+  remoteURL: string,
+  workDir: string
+): Promise<void> {
+  const publishDir = path.join(
+    `${process.env.GITHUB_WORKSPACE}`,
+    inps.PublishDir
+  );
+
+  core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
+  if (inps.ForceOrphan) {
+    await createWorkDir(workDir);
+    process.chdir(workDir);
+    await createBranchForce(inps.PublishBranch);
+    await copyAssets(publishDir, workDir);
+    return;
+  }
+
+  const result: CmdResult = {
+    exitcode: 0,
+    output: ''
+  };
+  const options = {
+    listeners: {
+      stdout: (data: Buffer): void => {
+        result.output += data.toString();
+      }
+    }
+  };
+
+  try {
+    result.exitcode = await exec.exec(
+      'git',
+      [
+        'clone',
+        '--depth=1',
+        '--single-branch',
+        '--branch',
+        inps.PublishBranch,
+        remoteURL,
+        workDir
+      ],
+      options
+    );
+    if (result.exitcode === 0) {
+      process.chdir(workDir);
+      if (inps.KeepFiles) {
+        core.info('[INFO] Keep existing files');
+      } else {
+        await exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+      }
+
+      await copyAssets(publishDir, workDir);
+      return;
+    } else {
+      throw new Error(`Failed to clone remote branch ${inps.PublishBranch}`);
+    }
+  } catch (e) {
+    core.info(
+      `[INFO] first deployment, create new branch ${inps.PublishBranch}`
+    );
+    core.info(e);
+    await createWorkDir(workDir);
+    process.chdir(workDir);
+    await createBranchForce(inps.PublishBranch);
+    await copyAssets(publishDir, workDir);
+    return;
+  }
+}
+
+export async function setConfig(
+  userName: string,
+  userEmail: string
+): Promise<void> {
+  await exec.exec('git', ['config', '--global', 'gc.auto', '0']);
+
+  let name = '';
+  if (userName) {
+    name = userName;
+  } else {
+    name = `${process.env.GITHUB_ACTOR}`;
+  }
+  await exec.exec('git', ['config', '--global', 'user.name', name]);
+
+  let email = '';
+  if (userName !== '' && userEmail !== '') {
+    email = userEmail;
+  } else {
+    email = `${process.env.GITHUB_ACTOR}@users.noreply.github.com`;
+  }
+  await exec.exec('git', ['config', '--global', 'user.email', email]);
+
+  return;
+}
+
+export async function commit(
+  allowEmptyCommit: boolean,
+  externalRepository: string,
+  message: string
+): Promise<void> {
+  let msg = '';
+  if (message) {
+    msg = message;
+  } else {
+    msg = 'deploy:';
+  }
+
+  const hash = `${process.env.GITHUB_SHA}`;
+  const baseRepo = `${github.context.repo.owner}/${github.context.repo.repo}`;
+  if (externalRepository) {
+    msg = `${msg} ${baseRepo}@${hash}`;
+  } else {
+    msg = `${msg} ${hash}`;
+  }
+
+  try {
+    if (allowEmptyCommit) {
+      await exec.exec('git', ['commit', '--allow-empty', '-m', `${msg}`]);
+    } else {
+      await exec.exec('git', ['commit', '-m', `${msg}`]);
+    }
+  } catch (e) {
+    core.info('[INFO] skip commit');
+    core.debug(`[INFO] skip commit ${e}`);
+  }
+}
+
+export async function push(
+  branch: string,
+  forceOrphan: boolean
+): Promise<void> {
+  if (forceOrphan) {
+    await exec.exec('git', ['push', 'origin', '--force', branch]);
+  } else {
+    await exec.exec('git', ['push', 'origin', branch]);
+  }
+}
+
+export async function pushTag(
+  tagName: string,
+  tagMessage: string
+): Promise<void> {
+  if (tagName === '') {
+    return;
+  }
+
+  let msg = '';
+  if (tagMessage) {
+    msg = tagMessage;
+  } else {
+    msg = `Deployment ${tagName}`;
+  }
+
+  await exec.exec('git', ['tag', '-a', `${tagName}`, '-m', `${msg}`]);
+  await exec.exec('git', ['push', 'origin', `${tagName}`]);
+}

src/index.ts

@@ -0,0 +1,10 @@
+import * as core from '@actions/core';
+import * as main from './main';
+
+(async (): Promise<void> => {
+  try {
+    await main.run();
+  } catch (e) {
+    core.setFailed(`Action failed with "${e}"`);
+  }
+})();

src/interfaces.ts

@@ -0,0 +1,23 @@
+export interface Inputs {
+  readonly DeployKey: string;
+  readonly GithubToken: string;
+  readonly PersonalToken: string;
+  readonly PublishBranch: string;
+  readonly PublishDir: string;
+  readonly ExternalRepository: string;
+  readonly AllowEmptyCommit: boolean;
+  readonly KeepFiles: boolean;
+  readonly ForceOrphan: boolean;
+  readonly UserName: string;
+  readonly UserEmail: string;
+  readonly CommitMessage: string;
+  readonly TagName: string;
+  readonly TagMessage: string;
+  readonly DisableNoJekyll: boolean;
+  readonly CNAME: string;
+}
+
+export interface CmdResult {
+  exitcode: number;
+  output: string;
+}

src/main.ts

@@ -0,0 +1,48 @@
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import {Inputs} from './interfaces';
+import {getInputs} from './get-inputs';
+import {setTokens} from './set-tokens';
+import * as git from './git-utils';
+import {getWorkDirName, addNoJekyll, addCNAME} from './utils';
+
+export async function run(): Promise<void> {
+  try {
+    const inps: Inputs = getInputs();
+
+    await git.setConfig(inps.UserName, inps.UserEmail);
+
+    const remoteURL = await setTokens(inps);
+    core.debug(`[INFO] remoteURL: ${remoteURL}`);
+
+    const date = new Date();
+    const unixTime = date.getTime();
+    const workDir = await getWorkDirName(`${unixTime}`);
+    await git.setRepo(inps, remoteURL, workDir);
+
+    await addNoJekyll(workDir, inps.DisableNoJekyll, inps.PublishBranch);
+    await addCNAME(workDir, inps.CNAME);
+
+    try {
+      await exec.exec('git', ['remote', 'rm', 'origin']);
+    } catch (e) {
+      core.info(`[INFO] ${e}`);
+    }
+    await exec.exec('git', ['remote', 'add', 'origin', remoteURL]);
+    await exec.exec('git', ['add', '--all']);
+
+    await git.commit(
+      inps.AllowEmptyCommit,
+      inps.ExternalRepository,
+      inps.CommitMessage
+    );
+    await git.push(inps.PublishBranch, inps.ForceOrphan);
+    await git.pushTag(inps.TagName, inps.TagMessage);
+
+    core.info('[INFO] Action successfully completed');
+
+    return;
+  } catch (e) {
+    throw new Error(e);
+  }
+}

src/set-tokens.ts

@@ -0,0 +1,122 @@
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import * as github from '@actions/github';
+import * as io from '@actions/io';
+import path from 'path';
+import fs from 'fs';
+const cpSpawnSync = require('child_process').spawnSync;
+const cpexec = require('child_process').execFileSync;
+import {Inputs} from './interfaces';
+import {getHomeDir} from './utils';
+
+export function setPublishRepo(insp: Inputs): string {
+  if (insp.ExternalRepository) {
+    return insp.ExternalRepository;
+  }
+  return `${github.context.repo.owner}/${github.context.repo.repo}`;
+}
+
+export async function setSSHKey(
+  inps: Inputs,
+  publishRepo: string
+): Promise<string> {
+  core.info('[INFO] setup SSH deploy key');
+
+  const homeDir = await getHomeDir();
+  const sshDir = path.join(homeDir, '.ssh');
+  await io.mkdirP(sshDir);
+  await exec.exec('chmod', ['700', sshDir]);
+
+  const knownHosts = path.join(sshDir, 'known_hosts');
+  // ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts on Ubuntu
+  const cmdSSHkeyscanOutput = `\
+# github.com:22 SSH-2.0-babeld-1f0633a6
+github.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==
+`;
+  fs.writeFileSync(knownHosts, cmdSSHkeyscanOutput + '\n');
+  core.info(`[INFO] wrote ${knownHosts}`);
+  await exec.exec('chmod', ['600', knownHosts]);
+
+  const idRSA = path.join(sshDir, 'github');
+  fs.writeFileSync(idRSA, inps.DeployKey + '\n');
+  core.info(`[INFO] wrote ${idRSA}`);
+  await exec.exec('chmod', ['600', idRSA]);
+
+  const sshConfigPath = path.join(sshDir, 'config');
+  const sshConfigContent = `\
+Host github
+    HostName github.com
+    IdentityFile ~/.ssh/github
+    User git
+`;
+  fs.writeFileSync(sshConfigPath, sshConfigContent + '\n');
+  core.info(`[INFO] wrote ${sshConfigPath}`);
+  await exec.exec('chmod', ['600', sshConfigPath]);
+
+  if (process.platform === 'win32') {
+    await cpSpawnSync('Start-Process', ['powershell.exe', '-Verb', 'runas']);
+    await cpSpawnSync('sh', ['-c', '\'eval "$(ssh-agent)"\''], {shell: true});
+    await exec.exec('sc', ['config', 'ssh-agent', 'start=auto']);
+    await exec.exec('sc', ['start', 'ssh-agent']);
+  }
+  await cpexec('ssh-agent', ['-a', '/tmp/ssh-auth.sock']);
+  core.exportVariable('SSH_AUTH_SOCK', '/tmp/ssh-auth.sock');
+  await exec.exec('ssh-add', [idRSA]);
+
+  return `git@github.com:${publishRepo}.git`;
+}
+
+export async function setGithubToken(
+  inps: Inputs,
+  publishRepo: string
+): Promise<string> {
+  core.info('[INFO] setup GITHUB_TOKEN');
+
+  const context = github.context;
+  core.debug(`ref: ${context.ref}`);
+  core.debug(`eventName: ${context.eventName}`);
+  let isProhibitedBranch = false;
+
+  const ref = context.ref;
+  if (context.eventName === 'push') {
+    isProhibitedBranch = ref.includes(`refs/heads/${inps.PublishBranch}`);
+    if (isProhibitedBranch) {
+      throw new Error(
+        `You deploy from ${inps.PublishBranch} to ${inps.PublishBranch}`
+      );
+    }
+  }
+
+  if (inps.ExternalRepository) {
+    throw new Error(
+      'GITHUB_TOKEN does not support to push to an external repository'
+    );
+  }
+
+  return `https://x-access-token:${inps.GithubToken}@github.com/${publishRepo}.git`;
+}
+
+export async function setPersonalToken(
+  inps: Inputs,
+  publishRepo: string
+): Promise<string> {
+  core.info('[INFO] setup personal access token');
+  return `https://x-access-token:${inps.PersonalToken}@github.com/${publishRepo}.git`;
+}
+
+export async function setTokens(inps: Inputs): Promise<string> {
+  try {
+    const publishRepo = setPublishRepo(inps);
+    if (inps.DeployKey) {
+      return setSSHKey(inps, publishRepo);
+    } else if (inps.GithubToken) {
+      return setGithubToken(inps, publishRepo);
+    } else if (inps.PersonalToken) {
+      return setPersonalToken(inps, publishRepo);
+    } else {
+      throw new Error('not found deploy key or tokens');
+    }
+  } catch (e) {
+    throw new Error(e);
+  }
+}

src/utils.ts

@@ -0,0 +1,64 @@
+import * as core from '@actions/core';
+import * as io from '@actions/io';
+import path from 'path';
+import fs from 'fs';
+
+export async function getHomeDir(): Promise<string> {
+  let homedir = '';
+
+  if (process.platform === 'win32') {
+    homedir = process.env['USERPROFILE'] || 'C:\\';
+  } else {
+    homedir = `${process.env.HOME}`;
+  }
+
+  core.debug(`homeDir: ${homedir}`);
+
+  return homedir;
+}
+
+export async function getWorkDirName(unixTime: string): Promise<string> {
+  const homeDir = await getHomeDir();
+  const workDirName = path.join(homeDir, `actions_github_pages_${unixTime}`);
+  return workDirName;
+}
+
+export async function createWorkDir(workDirName: string): Promise<void> {
+  await io.mkdirP(workDirName);
+  core.debug(`Created: ${workDirName}`);
+  return;
+}
+
+export async function addNoJekyll(
+  workDir: string,
+  DisableNoJekyll: boolean,
+  PublishBranch: string
+): Promise<void> {
+  if (DisableNoJekyll) {
+    return;
+  }
+  if (PublishBranch === 'master' || PublishBranch === 'gh-pages') {
+    const filepath = path.join(workDir, '.nojekyll');
+    if (fs.existsSync(filepath)) {
+      return;
+    }
+    fs.closeSync(fs.openSync(filepath, 'w'));
+    core.info(`[INFO] Created ${filepath}`);
+  }
+}
+
+export async function addCNAME(
+  workDir: string,
+  content: string
+): Promise<void> {
+  if (content === '') {
+    return;
+  }
+  const filepath = path.join(workDir, 'CNAME');
+  if (fs.existsSync(filepath)) {
+    core.warning(`CNAME already exists, skip adding CNAME`);
+    return;
+  }
+  fs.writeFileSync(filepath, content + '\n');
+  core.info(`[INFO] Created ${filepath}`);
+}

test_projects/mdbook/.gitignore

@@ -0,0 +1 @@
+book

test_projects/mdbook/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["peaceiris"]
+language = "en"
+multilingual = false
+src = "src"
+title = "GitHub Actions for GitHub Pages"

test_projects/mdbook/src/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+- [Chapter 1](./chapter_1.md)

test_projects/mdbook/src/chapter_1.md

@@ -0,0 +1,3 @@
+# Chapter 1
+
+test 7

tsconfig.json

@@ -0,0 +1,65 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                        /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./lib",                        /* Redirect output structure to the directory. */
+    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    "removeComments": true,                   /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}