chore(release): 3.5.1

/images/committer_github_actions_bot.jpg -- 15.70kb -> 13.58kb (13.46%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,7 +1,7 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: 'Bug: This is a sample issue title'
+title: 'sample_title'
 labels: bug
 assignees: peaceiris
 

.github/ISSUE_TEMPLATE/config.yml

@@ -3,6 +3,9 @@ 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
+  - name: GitHub Pages Documentation
     url: https://help.github.com/en/github/working-with-github-pages
-    about: GitHub Pages documentaion here.
+    about: GitHub Pages official documentaion here.
+  - name: GitHub Actions Documentation
+    url: https://help.github.com/en/actions
+    about: GitHub Actions official documentaion here.

.github/ISSUE_TEMPLATE/proposal.md

@@ -1,7 +1,7 @@
 ---
 name: Proposal
 about: Suggest an idea for this project
-title: 'proposal: This is a sample title'
+title: 'sample_title'
 labels: proposal
 assignees: peaceiris
 

.github/ISSUE_TEMPLATE/user_support.md

@@ -0,0 +1,31 @@
+---
+name: User support
+about: Questions for this action
+title: 'sample_title'
+labels: support
+assignees: peaceiris
+---
+
+**Check list before opening this issue**
+
+- [ ] I read the latest README
+  - I checked [Available Options](https://github.com/peaceiris/actions-gh-pages#options)
+  - I followed [Tips and FAQ](https://github.com/peaceiris/actions-gh-pages#tips-and-faq)
+  - I tried [Workflow Examples](https://github.com/peaceiris/actions-gh-pages#examples)
+
+**Describe your question**
+
+A clear and concise description of what the question is.
+
+**Link to your contents**
+
+- Link to your public repository here
+- Link to your workflow here
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your question.
+
+**Additional context**
+
+Add any other context about the problem here.

.github/workflows/pages-status-check.yml

@@ -0,0 +1,14 @@
+name: Check Pages Status
+
+on: page_build
+
+jobs:
+  pages-status-check:
+    runs-on: ubuntu-18.04
+    steps:
+      - name: check status
+        run: |
+          status = '${{ github.event.build.status }}'
+          errormsg = '${{ github.event.build.error.message }}'
+          assert status == 'built', 'Status: {status}\nError: {errormsg}'.format(status, errormsg)
+        shell: python

.github/workflows/release.yml

@@ -3,13 +3,12 @@ name: Release
 on:
   push:
     tags:
-    - 'v3.*.*'
+      - 'v3.*.*'
 
 jobs:
   release:
     runs-on: ubuntu-18.04
     steps:
-
       - uses: actions/checkout@v2
 
       - name: Dump GitHub context
@@ -19,8 +18,8 @@ jobs:
 
       - name: Install github/hub
         run: |
-          export HUB_VERSION="2.14.1"
+          export HUB_VERSION="2.14.2"
-          curl -fsSL https://github.com/github/hub/raw/40e421edd2c63d57bb8daa4bb9bbdfa21e8becf9/script/get | bash -s "${HUB_VERSION}"
+          curl -fsSL https://github.com/github/hub/raw/8d91904208171b013f9a9d1175f4ab39068db047/script/get | bash -s "${HUB_VERSION}"
 
       - name: Create release
         env:

.github/workflows/test-action.yml

@@ -30,7 +30,6 @@ jobs:
           - 'macos-latest'
           - 'windows-latest'
     steps:
-
       - uses: actions/checkout@v2
 
       - name: Read .nvmrc
@@ -42,7 +41,21 @@ jobs:
         with:
           node-version: '${{ steps.nvm.outputs.NVMRC }}'
 
+      - run: npm i -g npm
+
+      - name: Dump version
+        run: |
+          node -v
+          npm --version
+          git --version
+
       - 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
@@ -74,8 +87,8 @@ jobs:
           allow_empty_commit: true
           # keep_files: true
           # force_orphan: true
-          # user_name: iris
+          user_name: 'github-actions[bot]'
-          # user_email: email@peaceiris.com
+          user_email: 'github-actions[bot]@users.noreply.github.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

@@ -29,7 +29,6 @@ jobs:
           - 'macos-latest'
           - 'windows-latest'
     steps:
-
       - uses: actions/checkout@v2
 
       - name: Read .nvmrc
@@ -41,6 +40,14 @@ jobs:
         with:
           node-version: '${{ steps.nvm.outputs.NVMRC }}'
 
+      - run: npm i -g npm
+
+      - name: Dump version
+        run: |
+          node -v
+          npm --version
+          git --version
+
       - run: npm ci
 
       - name: Run prettier
@@ -62,3 +69,7 @@ jobs:
         with:
           name: coverage
           path: coverage
+
+      - uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.nvmrc

@@ -1 +1 @@
-12.14.1
+12.16.1

CHANGELOG.md

@@ -2,6 +2,271 @@
 
 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.5.1](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.0...v3.5.1) (2020-03-09)
+
+
+### chore
+
+* [ImgBot] Optimize images (#147) ([d8ed36f](https://github.com/peaceiris/actions-gh-pages/commit/d8ed36f54aee9f59e2e00fa7aceda885cd6d3eb8)), closes [#147](https://github.com/peaceiris/actions-gh-pages/issues/147)
+* Add missing descriptions ([a7bc3c3](https://github.com/peaceiris/actions-gh-pages/commit/a7bc3c37fdc9c640720165cb06fbffe20febe7a3))
+* Add user support issue template (#146) ([86214f3](https://github.com/peaceiris/actions-gh-pages/commit/86214f3d7909e3e81e38f0a73a897e00fc1198e4)), closes [#146](https://github.com/peaceiris/actions-gh-pages/issues/146) [#58](https://github.com/peaceiris/actions-gh-pages/issues/58)
+
+### ci
+
+* Add GitHub Actions bot as committer ([80c8fe5](https://github.com/peaceiris/actions-gh-pages/commit/80c8fe5fb32cd1e1b866e2d0d0d34cb1ba492586))
+* fix user_name ([f3b165f](https://github.com/peaceiris/actions-gh-pages/commit/f3b165fbe1a9ec4c9bd8b435ee13fc7cb10ef42a))
+* fix user_name ([945c44d](https://github.com/peaceiris/actions-gh-pages/commit/945c44d50a26eb6b24dbc0157dd836a39f9d5edb))
+* update script link [skip ci] ([c279167](https://github.com/peaceiris/actions-gh-pages/commit/c2791671998aa8f7858322a1bb74a1e74fb58923))
+
+### deps
+
+* bump @types/jest from 25.1.3 to 25.1.4 (#148) ([a4c25ca](https://github.com/peaceiris/actions-gh-pages/commit/a4c25ca7788f09428015b84ffd661ec30c7f2734)), closes [#148](https://github.com/peaceiris/actions-gh-pages/issues/148)
+* bump hub 2.14.1 to 2.14.2 ([618792b](https://github.com/peaceiris/actions-gh-pages/commit/618792b2f09d6b33bc394ffa2ffaec5ce48fc15d))
+
+### docs
+
+* Add bot committer image ([d2d8e21](https://github.com/peaceiris/actions-gh-pages/commit/d2d8e21d7ee28e4ab68e977f54ce0de33f9ae3ba))
+* Add GitHub Actions bot committer ([81884ef](https://github.com/peaceiris/actions-gh-pages/commit/81884efe7cbee81f6d73a96037ac547b3eda1b78))
+* Add notes about GitHub_TOKEN (#145) ([6852043](https://github.com/peaceiris/actions-gh-pages/commit/68520436f89fb253238c54f1ad6c5c3681c3e85b)), closes [#145](https://github.com/peaceiris/actions-gh-pages/issues/145)
+* fix user_name ([9571d29](https://github.com/peaceiris/actions-gh-pages/commit/9571d29e0df7e4a5bd5700f5531848e9158d7a2c))
+* fix user_name ([eb73e9c](https://github.com/peaceiris/actions-gh-pages/commit/eb73e9cb9d8ed1656b67a83c37e7dc1bc9c0dc00))
+* fix user_name ([860ed19](https://github.com/peaceiris/actions-gh-pages/commit/860ed1944f8968c2df2e052bd419a015ec10be38))
+
+
+
+# [3.5.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.4.1...v3.5.0) (2020-03-06)
+
+
+### deps
+
+* bump node 12.15.0 to 12.16.1 (#142) ([ade8887](https://github.com/peaceiris/actions-gh-pages/commit/ade88874791f5b67d0c475d6dffb5219ed4407f1)), closes [#142](https://github.com/peaceiris/actions-gh-pages/issues/142)
+
+### docs
+
+* improve description of enable_jekyll=disable_nojekyll (see #130) (#132) ([b76751b](https://github.com/peaceiris/actions-gh-pages/commit/b76751b9eefaaf771ce31d8ef3c69a8d907f535d)), closes [#130](https://github.com/peaceiris/actions-gh-pages/issues/130) [#132](https://github.com/peaceiris/actions-gh-pages/issues/132) [#130](https://github.com/peaceiris/actions-gh-pages/issues/130)
+
+### feat
+
+* Add enable_jekyll (#143) ([dc1169c](https://github.com/peaceiris/actions-gh-pages/commit/dc1169c5baf9ed1205d6f0f9c9ce0e6d26afb164)), closes [#143](https://github.com/peaceiris/actions-gh-pages/issues/143) [#130](https://github.com/peaceiris/actions-gh-pages/issues/130) [#132](https://github.com/peaceiris/actions-gh-pages/issues/132)
+
+
+
+# [3.5.0-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.4.1...v3.5.0-0) (2020-03-06)
+
+
+### deps
+
+* bump node 12.15.0 to 12.16.1 (#142) ([ade8887](https://github.com/peaceiris/actions-gh-pages/commit/ade88874791f5b67d0c475d6dffb5219ed4407f1)), closes [#142](https://github.com/peaceiris/actions-gh-pages/issues/142)
+
+### feat
+
+* Add enable_jekyll ([1fff2ca](https://github.com/peaceiris/actions-gh-pages/commit/1fff2ca84a6b42067a86c6229774aa5e2891a661))
+
+
+
+## [3.4.1](https://github.com/peaceiris/actions-gh-pages/compare/v3.4.0...v3.4.1) (2020-03-06)
+
+
+### ci
+
+* Add deployment status check workflow (#125) ([b81e21a](https://github.com/peaceiris/actions-gh-pages/commit/b81e21a3dc037a4037bef6bd44bc1bee36d3626f)), closes [#125](https://github.com/peaceiris/actions-gh-pages/issues/125)
+
+### deps
+
+* bump @actions/core from 1.2.2 to 1.2.3 (#140) ([ac39f89](https://github.com/peaceiris/actions-gh-pages/commit/ac39f890622b7f6950b6eb9cc43666c033277fb1)), closes [#140](https://github.com/peaceiris/actions-gh-pages/issues/140)
+* bump @types/node from 12.12.28 to 12.12.29 (#136) ([dd0b5df](https://github.com/peaceiris/actions-gh-pages/commit/dd0b5dfc6981e11137b2a1fad785d5342c0b5bc0)), closes [#136](https://github.com/peaceiris/actions-gh-pages/issues/136)
+* bump @typescript-eslint/eslint-plugin from 2.20.0 to 2.21.0 (#128) ([ce61f4b](https://github.com/peaceiris/actions-gh-pages/commit/ce61f4bf52b32c725cd5837e7b56d7a587a32af6)), closes [#128](https://github.com/peaceiris/actions-gh-pages/issues/128)
+* bump @typescript-eslint/eslint-plugin from 2.21.0 to 2.22.0 (#139) ([9faed51](https://github.com/peaceiris/actions-gh-pages/commit/9faed51ce97835a66741dc3d9368dc3402c12174)), closes [#139](https://github.com/peaceiris/actions-gh-pages/issues/139)
+* bump @typescript-eslint/parser from 2.20.0 to 2.21.0 (#127) ([bc18026](https://github.com/peaceiris/actions-gh-pages/commit/bc18026d43cd46451191723b7502ac0057177f5c)), closes [#127](https://github.com/peaceiris/actions-gh-pages/issues/127)
+* bump @typescript-eslint/parser from 2.21.0 to 2.22.0 (#138) ([7c45cb4](https://github.com/peaceiris/actions-gh-pages/commit/7c45cb42cade3f3bc0dab3c894044809b8ed4b4a)), closes [#138](https://github.com/peaceiris/actions-gh-pages/issues/138)
+* bump eslint-plugin-jest from 23.8.0 to 23.8.1 (#134) ([50988c1](https://github.com/peaceiris/actions-gh-pages/commit/50988c17ae540cf540cac254aeae22e8f1cbad46)), closes [#134](https://github.com/peaceiris/actions-gh-pages/issues/134)
+* bump eslint-plugin-jest from 23.8.1 to 23.8.2 (#141) ([acd0462](https://github.com/peaceiris/actions-gh-pages/commit/acd04627103a2d4d7620edca1bb74897a8180a84)), closes [#141](https://github.com/peaceiris/actions-gh-pages/issues/141)
+* bump lint-staged from 10.0.7 to 10.0.8 (#129) ([56fe697](https://github.com/peaceiris/actions-gh-pages/commit/56fe6978255c0fb44f70c59879daca5984de7ac4)), closes [#129](https://github.com/peaceiris/actions-gh-pages/issues/129)
+* bump typescript from 3.8.2 to 3.8.3 (#135) ([140391d](https://github.com/peaceiris/actions-gh-pages/commit/140391da91a8b458871e276b87abbfe7c0557c8c)), closes [#135](https://github.com/peaceiris/actions-gh-pages/issues/135)
+
+### docs
+
+* Add Docusaurus example (#131) ([a4da635](https://github.com/peaceiris/actions-gh-pages/commit/a4da635d8c553a327144267b3826e838aefb1561)), closes [#131](https://github.com/peaceiris/actions-gh-pages/issues/131)
+
+### test
+
+* Add testing for set-tokens.ts (#126) ([fd6e5fc](https://github.com/peaceiris/actions-gh-pages/commit/fd6e5fc7ce07cfd94a2311f7ac112bd797c3aee7)), closes [#126](https://github.com/peaceiris/actions-gh-pages/issues/126)
+
+
+
+# [3.4.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.3.0...v3.4.0) (2020-02-24)
+
+
+### deps
+
+* bump eslint-plugin-jest from 23.7.0 to 23.8.0 (#124) ([e0af1f7](https://github.com/peaceiris/actions-gh-pages/commit/e0af1f7de04642a5e810c38b24abd507d81b86be)), closes [#124](https://github.com/peaceiris/actions-gh-pages/issues/124)
+
+### docs
+
+* Put github_token as first example (#115) ([62e7849](https://github.com/peaceiris/actions-gh-pages/commit/62e7849d7ab5a2167baf529dc8fd9034fcf41c43)), closes [#115](https://github.com/peaceiris/actions-gh-pages/issues/115)
+* update ([7b12ca9](https://github.com/peaceiris/actions-gh-pages/commit/7b12ca9aebe1ddcf25dc1c6fd793308e703b4ec7))
+
+
+
+# [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)
 
 

Dockerfile

@@ -10,11 +10,13 @@ RUN apt-get update && \
     libcurl4-gnutls-dev libexpat1-dev gettext libz-dev libssl-dev autoconf \
     ca-certificates \
     wget \
-    ssh && \
+    ssh \
-    rm -rf /var/lib/apt/lists/*
+    vim && \
+    rm -rf /var/lib/apt/lists/* && \
+    npm i -g npm
 
 WORKDIR /git
-ENV GIT_VERSION="2.25.0"
+ENV GIT_VERSION="2.25.1"
 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" && \

README.md

@@ -28,9 +28,7 @@ The next example step will deploy `./public` directory to the remote `gh-pages`
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
   with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    github_token: ${{ secrets.GITHUB_TOKEN }}
-    # github_token: ${{ secrets.GITHUB_TOKEN }}
-    # personal_token: ${{ secrets.PERSONAL_TOKEN }}
     publish_dir: ./public
 ```
 
@@ -40,19 +38,19 @@ Three tokens are supported.
 
 | Token | Private repo | Public repo | Protocol | Setup |
 |---|:---:|:---:|---|---|
-| `github_token` | ✅️ | (1) | HTTPS | Unnecessary |
+| `github_token` | ✅️ | ✅️ | HTTPS | Unnecessary |
-| `personal_token` | ✅️ | ✅️ | HTTPS | Necessary |
 | `deploy_key` | ✅️ | ✅️ | SSH | Necessary |
+| `personal_token` | ✅️ | ✅️ | HTTPS | Necessary |
 
-1. Currently, GitHub Actions does not support to trigger a GitHub Pages build event using GITHUB_TOKEN on a public repository.
+Notes: Actually, the `GitHub_TOKEN` works for deploying to GitHub Pages but it has still some limitations. For the first deployment, we need to select the `gh-pages` branch or `master` branch on the repository settings tab. See [First Deployment with `GITHUB_TOKEN`](#%EF%B8%8F-first-deployment-with-github_token)
 
 ### Supported Platforms
 
-| runs-on | `deploy_key` | `github_token` | `personal_token` |
+| runs-on | `github_token` | `deploy_key` | `personal_token` |
 |---|:---:|:---:|:---:|
 | ubuntu-18.04 | ✅️ | ✅️ | ✅️ |
 | macos-latest | ✅️ | ✅️ | ✅️ |
-| windows-latest | (2) | ✅️ | ✅️ |
+| windows-latest | ✅️ | (2) | ✅️ |
 
 2. WIP, See [Issue #87](https://github.com/peaceiris/actions-gh-pages/issues/87)
 
@@ -65,13 +63,13 @@ Three tokens are supported.
 
 
 - [Getting started](#getting-started)
-  - [(1) Add SSH deploy key](#1-add-ssh-deploy-key)
+  - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
-  - [(2) Create your workflow](#2-create-your-workflow)
+  - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
-    - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
-    - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
 - [Options](#options)
+  - [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
   - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
-  - [⭐️ `github_token`](#%EF%B8%8F-github_token)
+  - [⭐️ CNAME](#%EF%B8%8F-cname)
+  - [⭐️ Enable Jekyll](#%EF%B8%8F-enable-jekyll)
   - [⭐️ 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)
@@ -80,20 +78,21 @@ Three tokens are supported.
   - [⭐️ 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)
+  - [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key)
+  - [⭐️ First Deployment with `GITHUB_TOKEN`](#%EF%B8%8F-first-deployment-with-github_token)
   - [⭐️ Use the latest and specific release](#%EF%B8%8F-use-the-latest-and-specific-release)
-  - [⭐️ How to add `CNAME`](#%EF%B8%8F-how-to-add-cname)
-  - [⭐️ Deployment completed but you cannot read](#%EF%B8%8F-deployment-completed-but-you-cannot-read)
 - [Examples](#examples)
   - [⭐️ Static Site Generators with Node.js](#%EF%B8%8F-static-site-generators-with-nodejs)
   - [⭐️ Gatsby](#%EF%B8%8F-gatsby)
   - [⭐️ React and Next](#%EF%B8%8F-react-and-next)
   - [⭐️ Vue and Nuxt](#%EF%B8%8F-vue-and-nuxt)
+  - [⭐️ Docusaurus](#%EF%B8%8F-docusaurus)
   - [⭐️ 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 -->
 
@@ -101,35 +100,9 @@ Three tokens are supported.
 
 ## Getting started
 
-### (1) Add SSH deploy key
+### ⭐️ Repository type - Project
 
-Generate your deploy key with the following command.
+Add your workflow file `.github/workflows/gh-pages.yml` and push to the remote master branch.
-
-```sh
-ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""
-# You will get 2 files:
-#   gh-pages.pub (public key)
-#   gh-pages     (private key)
-```
-
-Next, Go to **Repository Settings**
-
-- Go to **Deploy Keys** and add your public key with the **Allow write access**
-- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY`
-
-| Add your public key | Success |
-|---|---|
-| ![](./images/deploy-keys-1.jpg) | ![](./images/deploy-keys-2.jpg) |
-
-| Add your private key | Success |
-|---|---|
-| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
-
-### (2) Create your workflow
-
-Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch.
-
-#### ⭐️ Repository type - Project
 
 An example workflow for Hugo.
 
@@ -137,9 +110,6 @@ An example workflow for Hugo.
 
 [![peaceiris/actions-hugo - GitHub](https://gh-card.dev/repos/peaceiris/actions-hugo.svg?fullname)](https://github.com/peaceiris/actions-hugo)
 
-![peaceiris/actions-hugo latest version](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo)
-![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
-
 ```yaml
 name: github pages
 
@@ -149,7 +119,7 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v1
@@ -167,24 +137,22 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public
 ```
 
 The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
 
-| Actions log overview | Build step log |
+| Actions log overview | GitHub Pages log |
 |---|---|
-| ![](./images/log1.jpg) | ![](./images/log2.jpg) |
+| ![](./images/log_overview.jpg) | ![](./images/log_success.jpg) |
 
-| Deploy step log | GitHub Pages log |
+### ⭐️ Repository type - User and Organization
-|---|---|
-| ![](./images/log3.jpg) | ![](./images/log4.jpg) |
-
-#### ⭐️ Repository type - User and Organization
 
 For [User and Organization Pages sites] (`<username>/<username>.github.io` repository),
-we have to set `master` branch to `PUBLISH_BRANCH`.
+we have to set `master` branch to `publish_branch`.
+
+A default value of `publish_branch` is `gh-pages`.
 
 ```yaml
 on:
@@ -192,7 +160,20 @@ on:
     branches:
       - 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:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          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
@@ -209,28 +190,66 @@ publish_branch: master  # deploying branch
 
 ## Options
 
+### ⭐️ `deploy_key`
+
+Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH deploy key, and set the `deploy_key` option like the following.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+```
+
 ### ⭐️ `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
+
-- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+```yaml
-+ personal_token: ${{ secrets.PERSONAL_TOKEN }}
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    personal_token: ${{ secrets.PERSONAL_TOKEN }}
+    publish_dir: ./public
 ```
 
-### ⭐️ `github_token`
+### ⭐️ CNAME
 
-> ⚠️ **NOTES**: `github_token` works only on a **private** repository.
+To add `CNAME` file, we can set the `cname` option.
->
-> 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
+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)
 
-```diff
+```yaml
-- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+- name: Deploy
-+ github_token: ${{ secrets.GITHUB_TOKEN }}
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_dir: ./public
+    cname: github.com
 ```
 
+### ⭐️ Enable Jekyll
+
+If you want GitHub Pages to process the site with the static site generator Jekyll, set `enable_jekyll` to true.
+
+By default, this action signals to GitHub Pages that the site shall not be processed with Jekyll. This is done by adding an empty `.nojekyll` file when publishing to the master or gh-pages branch. When a `.nojekyll` file already exists, this action does nothing.
+
+Bypassing Jekyll makes the deployment faster and is necessary if you are deploying files or directories that start with underscores, since Jekyll considers these to be special resources and does not copy them to the final site. You only need to set `enable_jekyll` to true when you want to deploy a Jekyll-powered website and let GitHub Pages do the Jekyll processing.
+
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_dir: ./public
+    enable_jekyll: true
+```
+
+For more details about `.nojekyll`: [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
+
 ### ⭐️ 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`.
@@ -241,7 +260,7 @@ For example:
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
   with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./public
     allow_empty_commit: true
 ```
@@ -256,7 +275,7 @@ For example:
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
   with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./public
     keep_files: true
 ```
@@ -274,7 +293,7 @@ For example:
   with:
     deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
     external_repository: username/external-repository
-    publish_branch: gh-pages
+    publish_branch: master
     publish_dir: ./public
 ```
 
@@ -292,7 +311,7 @@ This allows you to make your publish branch with only the latest commit.
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
   with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./public
     force_orphan: true
 ```
@@ -306,12 +325,14 @@ A commit is always created with the same user.
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
   with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./public
-    user_name: iris
+    user_name: 'github-actions[bot]'
-    user_email: iris@peaceiris.com
+    user_email: 'github-actions[bot]@users.noreply.github.com'
 ```
 
+<img width="400px" alt="Add GitHub Actions bot as a committer" src="./images/committer_github_actions_bot.jpg">
+
 ### ⭐️ Set custom commit message
 
 Set custom commit message.
@@ -321,7 +342,7 @@ When we create a commit with a message `docs: Update some post`, a deployment co
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
   with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./public
     commit_message: ${{ github.event.head_commit.message }}
 ```
@@ -341,7 +362,7 @@ on:
       - 'v*.*.*'
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -359,7 +380,7 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public
           tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
           tag_message: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'
@@ -387,6 +408,42 @@ v1.2.3         # Tag on the master branch
 
 ## Tips and FAQ
 
+### ⭐️ Create SSH Deploy Key
+
+Generate your deploy key with the following command.
+
+```sh
+ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""
+# You will get 2 files:
+#   gh-pages.pub (public key)
+#   gh-pages     (private key)
+```
+
+Next, Go to **Repository Settings**
+
+- Go to **Deploy Keys** and add your public key with the **Allow write access**
+- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY`
+
+| Add your public key | Success |
+|---|---|
+| ![](./images/deploy-keys-1.jpg) | ![](./images/deploy-keys-2.jpg) |
+
+| Add your private key | Success |
+|---|---|
+| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
+
+### ⭐️ First Deployment with `GITHUB_TOKEN`
+
+The `GITHUB_TOKEN` has limitations for the first deployment so we have to select the GitHub Pages branch on the repository settings tab.
+
+| First deployment failed | Go to the settings tab |
+|---|---|
+| ![](./images/log_first_deployment_failed_with_github_token.jpg) | ![](./images/settings_inactive.jpg) |
+
+| Select branch | Deploying again and succeed |
+|---|---|
+| ![](./images/settings_select.jpg) | ![](./images/log_success.jpg) |
+
 ### ⭐️ Use the latest and specific release
 
 We recommend you to use the latest and specific release of this action for stable CI/CD.
@@ -394,47 +451,6 @@ It is useful to watch this repository (release only) to check the [latest releas
 
 [latest release]: https://github.com/peaceiris/actions-gh-pages/releases
 
-### ⭐️ How to add `CNAME`
-
-Most of the Static Site Generators support `CNAME` as a static file.
-
-- [Use a Custom Domain | Hugo](https://gohugo.io/hosting-and-deployment/hosting-on-github/#use-a-custom-domain)
-- [Using the Static folder | GatsbyJS](https://www.gatsbyjs.org/docs/static-folder/)
-
-The same may be said of other files (`.nojekyll`, `BingSiteAuth.xml`, `robots.txt`, etc.). It is better to manage those files by Static Site Generators.
-
-Does not your static site generator deal with the static files? No problem, you can add the file like the following.
-
-```yaml
-- name: Build
-  run: |
-    buildcommand
-    cp ./path/to/CNAME ./public/CNAME
-
-- name: Deploy
-```
-
-### ⭐️ Deployment completed but you cannot read
-
-Does your `publish_dir` contain files or directories that name starts with an underscore? (`_modules`, `_sources` and `_next`, etc.)
-GitHub Pages does not read those by default.
-Please add `.nojekyll` file to `publish_dir`.
-
-- [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
-
-> It is now possible to completely bypass Jekyll processing on GitHub Pages by creating a file named `.nojekyll` in the root of your pages repo and pushing it to GitHub. This should only be necessary if your site uses files or directories that start with underscores since Jekyll considers these to be special resources and does not copy them to the final site.
-
-Does not your static site generator deal with the static files? No problem, you can add the file like the following.
-
-```yaml
-- name: Build
-  run: |
-    buildcommand
-    touch ./public/.nojekyll
-
-- name: Deploy
-```
-
 <div align="right">
 <a href="#table-of-contents">Back to TOC ☝️</a>
 </div>
@@ -455,8 +471,6 @@ Does not your static site generator deal with the static files? No problem, you
 
 Premise: Dependencies are managed by `package.json` and `package-lock.json`
 
-![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
-
 ```yaml
 name: github pages
 
@@ -485,13 +499,12 @@ jobs:
             ${{ 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 }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public
 ```
 
@@ -502,8 +515,6 @@ An example for [Gatsby] (Gatsby.js) project with [gatsby-starter-blog]
 [Gatsby]: https://github.com/gatsbyjs/gatsby
 [gatsby-starter-blog]: https://github.com/gatsbyjs/gatsby-starter-blog
 
-![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
-
 ```yaml
 name: github pages
 
@@ -532,17 +543,14 @@ jobs:
             ${{ runner.os }}-node-
 
       - run: npm ci
-
       - run: npm run format
-
       - run: npm run test
-
       - run: npm run build
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public
 ```
 
@@ -555,8 +563,6 @@ An example for [Next.js] (React.js) project with [create-next-app]
 [Next.js]: https://github.com/zeit/next.js
 [create-next-app]: https://nextjs.org/docs
 
-![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
-
 ```yaml
 name: github pages
 
@@ -589,17 +595,13 @@ jobs:
             ${{ runner.os }}-yarn-
 
       - run: yarn install
-
       - run: yarn build
-
       - run: yarn export
 
-      - run: touch ./out/.nojekyll
-
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./out
 ```
 
@@ -612,8 +614,6 @@ An example for [Nuxt.js] (Vue.js) project with [create-nuxt-app]
 [Nuxt.js]: https://github.com/nuxt/nuxt.js
 [create-nuxt-app]: https://github.com/nuxt/create-nuxt-app
 
-![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
-
 ```yaml
 name: github pages
 
@@ -642,18 +642,69 @@ jobs:
             ${{ runner.os }}-node-
 
       - run: npm ci
-
       - run: npm test
-
       - run: npm run generate
 
       - name: deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./dist
 ```
 
+### ⭐️ Docusaurus
+
+An example for pages created using [Docusaurus](https://docusaurus.io/).
+
+Examples where this is being used:
+
+- [Mittens](https://github.com/ExpediaGroup/mittens)
+- [graphql-kotlin](https://github.com/ExpediaGroup/graphql-kotlin)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - 'website/**'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('website/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Build
+        run: |
+          cd website
+          npm ci
+          npm run build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # use the projectName from your siteConfig.js file: https://docusaurus.io/docs/en/site-config#projectname-string
+          publish_dir: ./website/build/<projectName>
+```
+
 ### ⭐️ Static Site Generators with Python
 
 [pelican], [MkDocs], [sphinx], etc.
@@ -664,8 +715,6 @@ jobs:
 
 Premise: Dependencies are managed by `requirements.txt`
 
-![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
-
 ```yaml
 name: github pages
 
@@ -704,7 +753,7 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./site
 ```
 
@@ -741,7 +790,7 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./book
 ```
 
@@ -787,7 +836,7 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./build/web
 ```
 
@@ -828,7 +877,7 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public
 ```
 
@@ -840,9 +889,9 @@ jobs:
 
 
 
-## About the author
+## Maintainer
 
-- [peaceiris's homepage](https://peaceiris.com/)
+- [peaceiris homepage](https://peaceiris.com/)
 
 
 

__tests__/get-inputs.test.ts

@@ -1,44 +1,107 @@
 // import * as main from '../src/main';
 import {Inputs} from '../src/interfaces';
-import {getInputs} from '../src/get-inputs';
+import {showInputs, getInputs} from '../src/get-inputs';
+import os from 'os';
+import fs from 'fs';
+import yaml from 'js-yaml';
 
 beforeEach(() => {
   jest.resetModules();
+  process.stdout.write = jest.fn();
+
+  const doc = yaml.safeLoad(
+    fs.readFileSync(__dirname + '/../action.yml', 'utf8')
+  );
+  Object.keys(doc.inputs).forEach(name => {
+    const envVar = `INPUT_${name.replace(/ /g, '_').toUpperCase()}`;
+    process.env[envVar] = doc.inputs[name]['default'];
+  });
 });
 
 afterEach(() => {
-  delete process.env['INPUT_DEPLOY_KEY'];
+  const doc = yaml.safeLoad(
-  delete process.env['INPUT_GITHUB_TOKEN'];
+    fs.readFileSync(__dirname + '/../action.yml', 'utf8')
-  delete process.env['INPUT_PERSONAL_TOKEN'];
+  );
-  delete process.env['INPUT_PUBLISH_BRANCH'];
+  Object.keys(doc.inputs).forEach(name => {
-  delete process.env['INPUT_PUBLISH_DIR'];
+    const envVar = `INPUT_${name.replace(/ /g, '_').toUpperCase()}`;
-  delete process.env['INPUT_EXTERNAL_REPOSITORY'];
+    console.debug(`delete ${envVar}\t${process.env[envVar]}`);
-  delete process.env['INPUT_ALLOW_EMPTY_COMMIT'];
+    delete process.env[envVar];
-  delete process.env['INPUT_KEEP_FILES'];
+  });
-  delete process.env['INPUT_FORCE_ORPHAN'];
+});
-  delete process.env['INPUT_USER_NAME'];
+
-  delete process.env['INPUT_USER_EMAIL'];
+// Assert that process.stdout.write calls called only with the given arguments.
-  delete process.env['INPUT_COMMIT_MESSAGE'];
+// cf. https://github.com/actions/toolkit/blob/8b0300129f08728419263b016de8630f1d426d5f/packages/core/__tests__/core.test.ts
-  delete process.env['INPUT_TAG_NAME'];
+function assertWriteCalls(calls: string[]): void {
-  delete process.env['INPUT_TAG_MESSAGE'];
+  expect(process.stdout.write).toHaveBeenCalledTimes(calls.length);
+
+  for (let i = 0; i < calls.length; i++) {
+    expect(process.stdout.write).toHaveBeenNthCalledWith(i + 1, calls[i]);
+  }
+}
+
+function getInputsLog(authMethod: string, inps: Inputs): string {
+  return `\
+[INFO] ${authMethod}: true
+[INFO] PublishBranch: ${inps.PublishBranch}
+[INFO] PublishDir: ${inps.PublishDir}
+[INFO] ExternalRepository: ${inps.ExternalRepository}
+[INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}
+[INFO] KeepFiles: ${inps.KeepFiles}
+[INFO] ForceOrphan: ${inps.ForceOrphan}
+[INFO] UserName: ${inps.UserName}
+[INFO] UserEmail: ${inps.UserEmail}
+[INFO] CommitMessage: ${inps.CommitMessage}
+[INFO] TagName: ${inps.TagName}
+[INFO] TagMessage: ${inps.TagMessage}
+[INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
+[INFO] CNAME: ${inps.CNAME}
+`;
+}
+
+describe('showInputs()', () => {
+  // eslint-disable-next-line jest/expect-expect
+  test('print all inputs DeployKey', () => {
+    process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
+
+    const inps: Inputs = getInputs();
+    showInputs(inps);
+
+    const authMethod = 'DeployKey';
+    const test = getInputsLog(authMethod, inps);
+    assertWriteCalls([`${test}${os.EOL}`]);
+  });
+
+  // eslint-disable-next-line jest/expect-expect
+  test('print all inputs GithubToken', () => {
+    delete process.env['INPUT_DEPLOY_KEY'];
+    process.env['INPUT_GITHUB_TOKEN'] = 'test_github_token';
+
+    const inps: Inputs = getInputs();
+    showInputs(inps);
+
+    const authMethod = 'GithubToken';
+    const test = getInputsLog(authMethod, inps);
+    assertWriteCalls([`${test}${os.EOL}`]);
+  });
+
+  // eslint-disable-next-line jest/expect-expect
+  test('print all inputs PersonalToken', () => {
+    delete process.env['INPUT_DEPLOY_KEY'];
+    delete process.env['INPUT_GITHUB_TOKEN'];
+    process.env['INPUT_PERSONAL_TOKEN'] = 'test_personal_token';
+
+    const inps: Inputs = getInputs();
+    showInputs(inps);
+
+    const authMethod = 'PersonalToken';
+    const test = getInputsLog(authMethod, inps);
+    assertWriteCalls([`${test}${os.EOL}`]);
+  });
 });
 
 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';
-    // 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';
 
     const inps: Inputs = getInputs();
 
@@ -56,6 +119,8 @@ describe('getInputs()', () => {
     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', () => {
@@ -73,6 +138,8 @@ describe('getInputs()', () => {
     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();
 
@@ -90,5 +157,17 @@ describe('getInputs()', () => {
     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');
+  });
+
+  test('throw error enable_jekyll or disable_nojekyll', () => {
+    process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
+    process.env['INPUT_ENABLE_JEKYLL'] = 'true';
+    process.env['INPUT_DISABLE_NOJEKYLL'] = 'true';
+
+    expect(() => {
+      getInputs();
+    }).toThrowError('Use either of enable_jekyll or disable_nojekyll');
   });
 });

__tests__/main.test.ts

@@ -1,32 +0,0 @@
-// 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__/set-tokens.test.ts

@@ -0,0 +1,105 @@
+import {
+  getPublishRepo,
+  setPersonalToken,
+  setGithubToken
+} from '../src/set-tokens';
+
+beforeEach(() => {
+  jest.resetModules();
+});
+
+// afterEach(() => {
+
+// });
+
+describe('getPublishRepo()', () => {
+  test('return repository name', () => {
+    const test = getPublishRepo('', 'owner', 'repo');
+    expect(test).toMatch('owner/repo');
+  });
+
+  test('return external repository name', () => {
+    const test = getPublishRepo('extOwner/extRepo', 'owner', 'repo');
+    expect(test).toMatch('extOwner/extRepo');
+  });
+});
+
+describe('setGithubToken()', () => {
+  test('return remote url with GITHUB_TOKEN gh-pages', () => {
+    const expected =
+      'https://x-access-token:GITHUB_TOKEN@github.com/owner/repo.git';
+    const test = setGithubToken(
+      'GITHUB_TOKEN',
+      'owner/repo',
+      'gh-pages',
+      '',
+      'refs/heads/master',
+      'push'
+    );
+    expect(test).toMatch(expected);
+  });
+
+  test('return remote url with GITHUB_TOKEN master', () => {
+    const expected =
+      'https://x-access-token:GITHUB_TOKEN@github.com/owner/repo.git';
+    const test = setGithubToken(
+      'GITHUB_TOKEN',
+      'owner/repo',
+      'master',
+      '',
+      'refs/heads/source',
+      'push'
+    );
+    expect(test).toMatch(expected);
+  });
+
+  test('throw error master to master', () => {
+    expect(() => {
+      setGithubToken(
+        'GITHUB_TOKEN',
+        'owner/repo',
+        'master',
+        '',
+        'refs/heads/master',
+        'push'
+      );
+    }).toThrowError('You deploy from master to master');
+  });
+
+  test('throw error external repository with GITHUB_TOKEN', () => {
+    expect(() => {
+      setGithubToken(
+        'GITHUB_TOKEN',
+        'owner/repo',
+        'gh-pages',
+        'extOwner/extRepo',
+        'refs/heads/master',
+        'push'
+      );
+    }).toThrowError(
+      'GITHUB_TOKEN does not support to push to an external repository'
+    );
+  });
+
+  test('return remote url with GITHUB_TOKEN pull_request', () => {
+    const expected =
+      'https://x-access-token:GITHUB_TOKEN@github.com/owner/repo.git';
+    const test = setGithubToken(
+      'GITHUB_TOKEN',
+      'owner/repo',
+      'gh-pages',
+      '',
+      'refs/pull/29/merge',
+      'pull_request'
+    );
+    expect(test).toMatch(expected);
+  });
+});
+
+describe('setPersonalToken()', () => {
+  test('return remote url with personal access token', () => {
+    const expected = 'https://x-access-token:pat@github.com/owner/repo.git';
+    const test = setPersonalToken('pat', 'owner/repo');
+    expect(test).toMatch(expected);
+  });
+});

__tests__/utils.test.ts

@@ -0,0 +1,205 @@
+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 test = fs.existsSync(filepath);
+    expect(test).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 test = fs.existsSync(filepath);
+    expect(test).toBe(true);
+
+    fs.unlinkSync(filepath);
+  });
+
+  test('.nojekyll already exists', async () => {
+    let workDir = '';
+    (async (): Promise<void> => {
+      workDir = await getWorkDir();
+    })();
+    const filepath = path.join(workDir, '.nojekyll');
+    fs.closeSync(fs.openSync(filepath, 'w'));
+
+    await addNoJekyll(workDir, false, 'master');
+    const test = fs.existsSync(filepath);
+    expect(test).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 test = fs.existsSync(filepath);
+    expect(test).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 test = fs.existsSync(filepath);
+    expect(test).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 test = fs.existsSync(filepath);
+    expect(test).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 test = fs.existsSync(filepath);
+    expect(test).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 test = fs.readFileSync(filepath, 'utf8');
+    expect(test).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 test = fs.existsSync(filepath);
+    expect(test).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 test = fs.readFileSync(filepath, 'utf8');
+    expect(test).toMatch('github.io');
+
+    fs.unlinkSync(filepath);
+  });
+});

action.yml

@@ -9,24 +9,24 @@ branding:
   color: 'blue'
 inputs:
   deploy_key:
-    description: ''
+    description: 'Set a SSH private key from repository secret value for pushing to the remote branch.'
     required: false
   github_token:
-    description: ''
+    description: 'Set a generated GITHUB_TOKEN for pushing to the remote branch.'
     required: false
   personal_token:
-    description: ''
+    description: 'Set a personal access token for pushing to the remote branch.'
     required: false
   publish_branch:
-    description: ''
+    description: 'Set a target branch for deployment.'
     required: false
     default: 'gh-pages'
   publish_dir:
-    description: ''
+    description: 'Set an input directory for deployment.'
     required: false
     default: 'public'
   external_repository:
-    description: ''
+    description: 'Set an external repository (owner/repo).'
     required: false
   allow_empty_commit:
     description: 'If empty commits should be made to the publication branch'
@@ -55,3 +55,14 @@ inputs:
   tag_message:
     description: 'Set tag message'
     required: false
+  enable_jekyll:
+    description: 'Enable the GitHub Pages built-in Jekyll'
+    required: false
+    default: 'false'
+  disable_nojekyll:
+    description: 'An alias for enable_jekyll to disable adding .nojekyll file to master or gh-pages branches'
+    required: false
+    default: 'false'
+  cname:
+    description: 'Set custom domain'
+    required: false

lib/index.js

@@ -2252,30 +2252,37 @@ const exec = __importStar(__webpack_require__(986));
 const get_inputs_1 = __webpack_require__(452);
 const set_tokens_1 = __webpack_require__(615);
 const git = __importStar(__webpack_require__(496));
+const utils_1 = __webpack_require__(163);
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const inps = get_inputs_1.getInputs();
+            get_inputs_1.showInputs(inps);
             yield git.setConfig(inps.UserName, inps.UserEmail);
             const remoteURL = yield set_tokens_1.setTokens(inps);
             core.debug(`[INFO] remoteURL: ${remoteURL}`);
-            yield git.setRepo(inps, remoteURL);
+            const date = new Date();
+            const unixTime = date.getTime();
+            const workDir = yield utils_1.getWorkDirName(`${unixTime}`);
+            yield git.setRepo(inps, remoteURL, workDir);
+            yield utils_1.addNoJekyll(workDir, inps.DisableNoJekyll, inps.PublishBranch);
+            yield utils_1.addCNAME(workDir, inps.CNAME);
             try {
                 yield exec.exec('git', ['remote', 'rm', 'origin']);
             }
             catch (e) {
-                core.info(`[INFO] e`);
+                core.info(`[INFO] ${e.message}`);
             }
             yield exec.exec('git', ['remote', 'add', 'origin', remoteURL]);
             yield exec.exec('git', ['add', '--all']);
             yield git.commit(inps.AllowEmptyCommit, inps.ExternalRepository, inps.CommitMessage);
             yield git.push(inps.PublishBranch, inps.ForceOrphan);
             yield git.pushTag(inps.TagName, inps.TagMessage);
-            core.info('[INFO] successfully deployed');
+            core.info('[INFO] Action successfully completed');
             return;
         }
         catch (e) {
-            throw new Error(e);
+            throw new Error(e.message);
         }
     });
 }
@@ -2663,6 +2670,15 @@ function paginatePlugin(octokit) {
 
 "use strict";
 
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
@@ -2670,20 +2686,75 @@ var __importStar = (this && this.__importStar) || function (mod) {
     result["default"] = mod;
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(__webpack_require__(470));
+const io = __importStar(__webpack_require__(1));
+const path_1 = __importDefault(__webpack_require__(622));
+const fs_1 = __importDefault(__webpack_require__(747));
 function getHomeDir() {
-    let homedir = '';
+    return __awaiter(this, void 0, void 0, function* () {
-    if (process.platform === 'win32') {
+        let homedir = '';
-        homedir = process.env['USERPROFILE'] || 'C:\\';
+        if (process.platform === 'win32') {
-    }
+            homedir = process.env['USERPROFILE'] || 'C:\\';
-    else {
+        }
-        homedir = `${process.env.HOME}`;
+        else {
-    }
+            homedir = `${process.env.HOME}`;
-    core.debug(`homeDir: ${homedir}`);
+        }
-    return homedir;
+        core.debug(`homeDir: ${homedir}`);
+        return homedir;
+    });
 }
 exports.getHomeDir = getHomeDir;
+function getWorkDirName(unixTime) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const homeDir = yield getHomeDir();
+        const workDirName = path_1.default.join(homeDir, `actions_github_pages_${unixTime}`);
+        return workDirName;
+    });
+}
+exports.getWorkDirName = getWorkDirName;
+function createWorkDir(workDirName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield io.mkdirP(workDirName);
+        core.debug(`Created: ${workDirName}`);
+        return;
+    });
+}
+exports.createWorkDir = createWorkDir;
+function addNoJekyll(workDir, DisableNoJekyll, PublishBranch) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (DisableNoJekyll) {
+            return;
+        }
+        if (PublishBranch === 'master' || PublishBranch === 'gh-pages') {
+            const filepath = path_1.default.join(workDir, '.nojekyll');
+            if (fs_1.default.existsSync(filepath)) {
+                return;
+            }
+            fs_1.default.closeSync(fs_1.default.openSync(filepath, 'w'));
+            core.info(`[INFO] Created ${filepath}`);
+        }
+    });
+}
+exports.addNoJekyll = addNoJekyll;
+function addCNAME(workDir, content) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (content === '') {
+            return;
+        }
+        const filepath = path_1.default.join(workDir, 'CNAME');
+        if (fs_1.default.existsSync(filepath)) {
+            core.warning(`CNAME already exists, skip adding CNAME`);
+            return;
+        }
+        fs_1.default.writeFileSync(filepath, content + '\n');
+        core.info(`[INFO] Created ${filepath}`);
+    });
+}
+exports.addCNAME = addCNAME;
 
 
 /***/ }),
@@ -5028,7 +5099,7 @@ const main = __importStar(__webpack_require__(131));
         yield main.run();
     }
     catch (e) {
-        core.setFailed(`Action failed with "${e}"`);
+        core.setFailed(`Action failed with "${e.message}"`);
     }
 }))();
 
@@ -5974,28 +6045,47 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(__webpack_require__(470));
 function showInputs(inps) {
+    let authMethod = '';
     if (inps.DeployKey) {
-        core.info(`[INFO] DeployKey: true`);
+        authMethod = 'DeployKey';
     }
     else if (inps.GithubToken) {
-        core.info(`[INFO] GithubToken: true`);
+        authMethod = 'GithubToken';
     }
     else if (inps.PersonalToken) {
-        core.info(`[INFO] PersonalToken: true`);
+        authMethod = 'PersonalToken';
     }
-    core.info(`[INFO] PublishBranch: ${inps.PublishBranch}`);
+    core.info(`\
-    core.info(`[INFO] PublishDir: ${inps.PublishDir}`);
+[INFO] ${authMethod}: true
-    core.info(`[INFO] ExternalRepository: ${inps.ExternalRepository}`);
+[INFO] PublishBranch: ${inps.PublishBranch}
-    core.info(`[INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}`);
+[INFO] PublishDir: ${inps.PublishDir}
-    core.info(`[INFO] KeepFiles: ${inps.KeepFiles}`);
+[INFO] ExternalRepository: ${inps.ExternalRepository}
-    core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
+[INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}
-    core.info(`[INFO] UserEmail: ${inps.UserEmail}`);
+[INFO] KeepFiles: ${inps.KeepFiles}
-    core.info(`[INFO] UserEmail: ${inps.UserEmail}`);
+[INFO] ForceOrphan: ${inps.ForceOrphan}
-    core.info(`[INFO] CommitMessage: ${inps.CommitMessage}`);
+[INFO] UserName: ${inps.UserName}
-    core.info(`[INFO] TagName: ${inps.TagName}`);
+[INFO] UserEmail: ${inps.UserEmail}
-    core.info(`[INFO] TagMessage: ${inps.TagMessage}`);
+[INFO] CommitMessage: ${inps.CommitMessage}
+[INFO] TagName: ${inps.TagName}
+[INFO] TagMessage: ${inps.TagMessage}
+[INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
+[INFO] CNAME: ${inps.CNAME}
+`);
 }
+exports.showInputs = showInputs;
 function getInputs() {
+    let useBuiltinJekyll = false;
+    const enableJekyll = (core.getInput('enable_jekyll') || 'false').toUpperCase() === 'TRUE';
+    const disableNoJekyll = (core.getInput('disable_nojekyll') || 'false').toUpperCase() === 'TRUE';
+    if (enableJekyll && disableNoJekyll) {
+        throw new Error(`Use either of enable_jekyll or disable_nojekyll`);
+    }
+    else if (enableJekyll) {
+        useBuiltinJekyll = true;
+    }
+    else if (disableNoJekyll) {
+        useBuiltinJekyll = true;
+    }
     const inps = {
         DeployKey: core.getInput('deploy_key'),
         GithubToken: core.getInput('github_token'),
@@ -6010,9 +6100,10 @@ function getInputs() {
         UserEmail: core.getInput('user_email'),
         CommitMessage: core.getInput('commit_message'),
         TagName: core.getInput('tag_name'),
-        TagMessage: core.getInput('tag_message')
+        TagMessage: core.getInput('tag_message'),
+        DisableNoJekyll: useBuiltinJekyll,
+        CNAME: core.getInput('cname')
     };
-    showInputs(inps);
     return inps;
 }
 exports.getInputs = getInputs;
@@ -7880,9 +7971,6 @@ exports.RequestError = RequestError;
 
 "use strict";
 
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
@@ -7893,13 +7981,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/master/src/github.ts
 const graphql_1 = __webpack_require__(898);
-const rest_1 = __importDefault(__webpack_require__(0));
+const rest_1 = __webpack_require__(0);
 const Context = __importStar(__webpack_require__(262));
 const httpClient = __importStar(__webpack_require__(539));
 // We need this in order to extend Octokit
-rest_1.default.prototype = new rest_1.default();
+rest_1.Octokit.prototype = new rest_1.Octokit();
 exports.context = new Context.Context();
-class GitHub extends rest_1.default {
+class GitHub extends rest_1.Octokit {
     constructor(token, opts) {
         super(GitHub.getOctokitOptions(GitHub.disambiguate(token, opts)));
         this.graphql = GitHub.getGraphQL(GitHub.disambiguate(token, opts));
@@ -8086,6 +8174,13 @@ exports.setFailed = setFailed;
 //-----------------------------------------------------------------------
 // Logging Commands
 //-----------------------------------------------------------------------
+/**
+ * Gets whether Actions Step Debug is on or not
+ */
+function isDebug() {
+    return process.env['RUNNER_DEBUG'] === '1';
+}
+exports.isDebug = isDebug;
 /**
  * Writes debug message to user log
  * @param message debug message
@@ -8329,14 +8424,6 @@ const io = __importStar(__webpack_require__(1));
 const path_1 = __importDefault(__webpack_require__(622));
 const fs_1 = __importDefault(__webpack_require__(747));
 const utils_1 = __webpack_require__(163);
-function createWorkDir(workDirName) {
-    return __awaiter(this, void 0, void 0, function* () {
-        yield io.mkdirP(workDirName);
-        core.debug(`workDir was created: ${workDirName}`);
-        return;
-    });
-}
-exports.createWorkDir = createWorkDir;
 function createBranchForce(branch) {
     return __awaiter(this, void 0, void 0, function* () {
         yield exec.exec('git', ['init']);
@@ -8373,13 +8460,12 @@ function copyAssets(publishDir, workDir) {
     });
 }
 exports.copyAssets = copyAssets;
-function setRepo(inps, remoteURL) {
+function setRepo(inps, remoteURL, workDir) {
     return __awaiter(this, void 0, void 0, function* () {
-        const workDir = path_1.default.join(utils_1.getHomeDir(), 'actions_github_pages');
         const publishDir = path_1.default.join(`${process.env.GITHUB_WORKSPACE}`, inps.PublishDir);
         core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
         if (inps.ForceOrphan) {
-            yield createWorkDir(workDir);
+            yield utils_1.createWorkDir(workDir);
             process.chdir(workDir);
             yield createBranchForce(inps.PublishBranch);
             yield copyAssets(publishDir, workDir);
@@ -8396,29 +8482,36 @@ function setRepo(inps, remoteURL) {
                 }
             }
         };
-        result.exitcode = yield exec.exec('git', [
+        try {
-            'clone',
+            result.exitcode = yield exec.exec('git', [
-            '--depth=1',
+                'clone',
-            '--single-branch',
+                '--depth=1',
-            '--branch',
+                '--single-branch',
-            inps.PublishBranch,
+                '--branch',
-            remoteURL,
+                inps.PublishBranch,
-            workDir
+                remoteURL,
-        ], options);
+                workDir
-        process.chdir(workDir);
+            ], options);
-        if (result.exitcode === 0) {
+            if (result.exitcode === 0) {
-            if (inps.KeepFiles) {
+                process.chdir(workDir);
-                core.info('[INFO] Keep existing files');
+                if (inps.KeepFiles) {
+                    core.info('[INFO] Keep existing files');
+                }
+                else {
+                    yield exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+                }
+                yield copyAssets(publishDir, workDir);
+                return;
             }
             else {
-                yield exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+                throw new Error(`Failed to clone remote branch ${inps.PublishBranch}`);
             }
-            yield copyAssets(publishDir, workDir);
-            return;
         }
-        else {
+        catch (e) {
             core.info(`[INFO] first deployment, create new branch ${inps.PublishBranch}`);
-            yield createWorkDir(workDir);
+            core.info(e.message);
+            yield utils_1.createWorkDir(workDir);
+            process.chdir(workDir);
             yield createBranchForce(inps.PublishBranch);
             yield copyAssets(publishDir, workDir);
             return;
@@ -8476,7 +8569,7 @@ function commit(allowEmptyCommit, externalRepository, message) {
         }
         catch (e) {
             core.info('[INFO] skip commit');
-            core.debug(`[INFO] skip commit ${e}`);
+            core.debug(`[INFO] skip commit ${e.message}`);
         }
     });
 }
@@ -9511,29 +9604,11 @@ const path_1 = __importDefault(__webpack_require__(622));
 const fs_1 = __importDefault(__webpack_require__(747));
 const cpSpawnSync = __webpack_require__(129).spawnSync;
 const cpexec = __webpack_require__(129).execFileSync;
-function getHomeDir() {
+const utils_1 = __webpack_require__(163);
-    let homedir = '';
-    if (process.platform === 'win32') {
-        homedir = process.env['USERPROFILE'] || 'C:\\';
-    }
-    else {
-        homedir = `${process.env.HOME}`;
-    }
-    core.debug(`homeDir: ${homedir}`);
-    return homedir;
-}
-exports.getHomeDir = getHomeDir;
-function setPublishRepo(insp) {
-    if (insp.ExternalRepository) {
-        return insp.ExternalRepository;
-    }
-    return `${github.context.repo.owner}/${github.context.repo.repo}`;
-}
-exports.setPublishRepo = setPublishRepo;
 function setSSHKey(inps, publishRepo) {
     return __awaiter(this, void 0, void 0, function* () {
         core.info('[INFO] setup SSH deploy key');
-        const homeDir = getHomeDir();
+        const homeDir = yield utils_1.getHomeDir();
         const sshDir = path_1.default.join(homeDir, '.ssh');
         yield io.mkdirP(sshDir);
         yield exec.exec('chmod', ['700', sshDir]);
@@ -9572,63 +9647,57 @@ Host github
     });
 }
 exports.setSSHKey = setSSHKey;
-function setGithubToken(inps, publishRepo) {
+function setGithubToken(githubToken, publishRepo, publishBranch, externalRepository, ref, eventName) {
-    var _a, _b;
+    core.info('[INFO] setup GITHUB_TOKEN');
-    return __awaiter(this, void 0, void 0, function* () {
+    core.debug(`ref: ${ref}`);
-        core.info('[INFO] setup GITHUB_TOKEN');
+    core.debug(`eventName: ${eventName}`);
-        const context = github.context;
+    let isProhibitedBranch = false;
-        const payload = github.context.payload;
+    if (eventName === 'push') {
-        core.debug(`ref: ${context.ref}`);
+        isProhibitedBranch = ref.includes(`refs/heads/${publishBranch}`);
-        core.debug(`eventName: ${context.eventName}`);
+        if (isProhibitedBranch) {
-        core.debug(`private: ${(_a = payload.repository) === null || _a === void 0 ? void 0 : _a.private}`);
+            throw new Error(`You deploy from ${publishBranch} to ${publishBranch}`);
-        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}`);
-            }
         }
-        else if (context.eventName === 'pull_request') {
+    }
-            throw new Error('This action does not support pull_request event now.');
+    if (externalRepository) {
-        }
+        throw new Error('GITHUB_TOKEN does not support to push to an external repository');
-        const isPrivateRepository = (_b = payload.repository) === null || _b === void 0 ? void 0 : _b.private;
+    }
-        if (inps.ExternalRepository) {
+    return `https://x-access-token:${githubToken}@github.com/${publishRepo}.git`;
-            throw new Error('GITHUB_TOKEN does not support to push to an external repository');
-        }
-        if (isPrivateRepository === false) {
-            core.warning('GITHUB_TOKEN does not support to trigger the GitHub Pages build event on a public repository');
-        }
-        return `https://x-access-token:${inps.GithubToken}@github.com/${publishRepo}.git`;
-    });
 }
 exports.setGithubToken = setGithubToken;
-function setPersonalToken(inps, publishRepo) {
+function setPersonalToken(personalToken, publishRepo) {
-    return __awaiter(this, void 0, void 0, function* () {
+    core.info('[INFO] setup personal access token');
-        core.info('[INFO] setup personal access token');
+    return `https://x-access-token:${personalToken}@github.com/${publishRepo}.git`;
-        return `https://x-access-token:${inps.PersonalToken}@github.com/${publishRepo}.git`;
-    });
 }
 exports.setPersonalToken = setPersonalToken;
+function getPublishRepo(externalRepository, owner, repo) {
+    if (externalRepository) {
+        return externalRepository;
+    }
+    return `${owner}/${repo}`;
+}
+exports.getPublishRepo = getPublishRepo;
 function setTokens(inps) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const publishRepo = setPublishRepo(inps);
+            const publishRepo = getPublishRepo(inps.ExternalRepository, github.context.repo.owner, github.context.repo.repo);
             if (inps.DeployKey) {
                 return setSSHKey(inps, publishRepo);
             }
             else if (inps.GithubToken) {
-                return setGithubToken(inps, publishRepo);
+                const context = github.context;
+                const ref = context.ref;
+                const eventName = context.eventName;
+                return setGithubToken(inps.GithubToken, publishRepo, inps.PublishBranch, inps.ExternalRepository, ref, eventName);
             }
             else if (inps.PersonalToken) {
-                return setPersonalToken(inps, publishRepo);
+                return setPersonalToken(inps.PersonalToken, publishRepo);
             }
             else {
                 throw new Error('not found deploy key or tokens');
             }
         }
         catch (e) {
-            throw new Error(e);
+            throw new Error(e.message);
         }
     });
 }

package-lock.json

@@ -1,13 +1,13 @@
 {
   "name": "actions-github-pages",
-  "version": "3.0.2",
+  "version": "3.5.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
     "@actions/core": {
-      "version": "1.2.2",
+      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.2.tgz",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.3.tgz",
-      "integrity": "sha512-IbCx7oefq+Gi6FWbSs2Fnw8VkEI6Y4gvjrYprY3RV//ksq/KPMlClOerJ4jRosyal6zkUIc8R9fS/cpRMlGClg=="
+      "integrity": "sha512-Wp4xnyokakM45Uuj4WLUxdsa8fJjKVl1fDTsPbTEcTcuu0Nb26IPQbOtjmnfaCPGcaoPOOqId8H9NapZ8gii4w=="
     },
     "@actions/exec": {
       "version": "1.0.3",
@@ -18,13 +18,13 @@
       }
     },
     "@actions/github": {
-      "version": "2.1.0",
+      "version": "2.1.1",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-2.1.0.tgz",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-2.1.1.tgz",
-      "integrity": "sha512-G4ncMlh4pLLAvNgHUYUtpWQ1zPf/VYqmRH9oshxLabdaOOnp7i1hgSgzr2xne2YUaSND3uqemd3YYTIsm2f/KQ==",
+      "integrity": "sha512-kAgTGUx7yf5KQCndVeHSwCNZuDBvPyxm5xKTswW2lofugeuC1AZX73nUUVDNaysnM9aKFMHv9YCdVJbg7syEyA==",
       "requires": {
         "@actions/http-client": "^1.0.3",
         "@octokit/graphql": "^4.3.1",
-        "@octokit/rest": "^16.15.0"
+        "@octokit/rest": "^16.43.1"
       }
     },
     "@actions/http-client": {
@@ -740,15 +740,21 @@
       }
     },
     "@types/jest": {
-      "version": "25.1.1",
+      "version": "25.1.4",
-      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-25.1.1.tgz",
+      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-25.1.4.tgz",
-      "integrity": "sha512-bKSZJYZJLzwaoVYNN4W3A0RvKNYsrLm5tsuXaMlfYDxKf4gY2sFrMYneCugNQWGg1gjPW+FHBwNrwPzEi4sIsw==",
+      "integrity": "sha512-QDDY2uNAhCV7TMCITrxz+MRk1EizcsevzfeS6LykIlq2V1E5oO4wXG8V2ZEd9w7Snxeeagk46YbMgZ8ESHx3sw==",
       "dev": true,
       "requires": {
         "jest-diff": "^25.1.0",
         "pretty-format": "^25.1.0"
       }
     },
+    "@types/js-yaml": {
+      "version": "3.12.2",
+      "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-3.12.2.tgz",
+      "integrity": "sha512-0CFu/g4mDSNkodVwWijdlr8jH7RoplRWNgovjFLEZeT+QEbbZXjBmCe3HwaWheAlCbHwomTwzZoSedeOycABug==",
+      "dev": true
+    },
     "@types/json-schema": {
       "version": "7.0.4",
       "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.4.tgz",
@@ -756,9 +762,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "13.7.0",
+      "version": "12.12.29",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-13.7.0.tgz",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.29.tgz",
-      "integrity": "sha512-GnZbirvmqZUzMgkFn70c74OQpTTUcCzlhQliTzYjQMqg+hVKcDnxdL19Ne3UdYzdMA/+W3eb646FWn/ZaT1NfQ=="
+      "integrity": "sha512-yo8Qz0ygADGFptISDj3pOC9wXfln/5pQaN/ysDIzOaAWXt73cNHmtEC8zSO2Y+kse/txmwIAJzkYZ5fooaS5DQ=="
     },
     "@types/parse-json": {
       "version": "4.0.0",
@@ -788,45 +794,113 @@
       "dev": true
     },
     "@typescript-eslint/eslint-plugin": {
-      "version": "2.19.0",
+      "version": "2.22.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-2.19.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-2.22.0.tgz",
-      "integrity": "sha512-u7IcQ9qwsB6U806LupZmINRnQjC+RJyv36sV/ugaFWMHTbFm/hlLTRx3gGYJgHisxcGSTnf+I/fPDieRMhPSQQ==",
+      "integrity": "sha512-BvxRLaTDVQ3N+Qq8BivLiE9akQLAOUfxNHIEhedOcg8B2+jY8Rc4/D+iVprvuMX1AdezFYautuGDwr9QxqSxBQ==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/experimental-utils": "2.19.0",
+        "@typescript-eslint/experimental-utils": "2.22.0",
         "eslint-utils": "^1.4.3",
         "functional-red-black-tree": "^1.0.1",
         "regexpp": "^3.0.0",
         "tsutils": "^3.17.1"
+      },
+      "dependencies": {
+        "@typescript-eslint/experimental-utils": {
+          "version": "2.22.0",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-2.22.0.tgz",
+          "integrity": "sha512-sJt1GYBe6yC0dWOQzXlp+tiuGglNhJC9eXZeC8GBVH98Zv9jtatccuhz0OF5kC/DwChqsNfghHx7OlIDQjNYAQ==",
+          "dev": true,
+          "requires": {
+            "@types/json-schema": "^7.0.3",
+            "@typescript-eslint/typescript-estree": "2.22.0",
+            "eslint-scope": "^5.0.0"
+          }
+        },
+        "@typescript-eslint/typescript-estree": {
+          "version": "2.22.0",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-2.22.0.tgz",
+          "integrity": "sha512-2HFZW2FQc4MhIBB8WhDm9lVFaBDy6h9jGrJ4V2Uzxe/ON29HCHBTj3GkgcsgMWfsl2U5as+pTOr30Nibaw7qRQ==",
+          "dev": true,
+          "requires": {
+            "debug": "^4.1.1",
+            "eslint-visitor-keys": "^1.1.0",
+            "glob": "^7.1.6",
+            "is-glob": "^4.0.1",
+            "lodash": "^4.17.15",
+            "semver": "^6.3.0",
+            "tsutils": "^3.17.1"
+          }
+        },
+        "semver": {
+          "version": "6.3.0",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
+          "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+          "dev": true
+        }
       }
     },
     "@typescript-eslint/experimental-utils": {
-      "version": "2.19.0",
+      "version": "2.22.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-2.19.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-2.22.0.tgz",
-      "integrity": "sha512-zwpg6zEOPbhB3+GaQfufzlMUOO6GXCNZq6skk+b2ZkZAIoBhVoanWK255BS1g5x9bMwHpLhX0Rpn5Fc3NdCZdg==",
+      "integrity": "sha512-sJt1GYBe6yC0dWOQzXlp+tiuGglNhJC9eXZeC8GBVH98Zv9jtatccuhz0OF5kC/DwChqsNfghHx7OlIDQjNYAQ==",
       "dev": true,
       "requires": {
         "@types/json-schema": "^7.0.3",
-        "@typescript-eslint/typescript-estree": "2.19.0",
+        "@typescript-eslint/typescript-estree": "2.22.0",
         "eslint-scope": "^5.0.0"
       }
     },
     "@typescript-eslint/parser": {
-      "version": "2.19.0",
+      "version": "2.22.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-2.19.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-2.22.0.tgz",
-      "integrity": "sha512-s0jZoxAWjHnuidbbN7aA+BFVXn4TCcxEVGPV8lWMxZglSs3NRnFFAlL+aIENNmzB2/1jUJuySi6GiM6uACPmpg==",
+      "integrity": "sha512-FaZKC1X+nvD7qMPqKFUYHz3H0TAioSVFGvG29f796Nc5tBluoqfHgLbSFKsh7mKjRoeTm8J9WX2Wo9EyZWjG7w==",
       "dev": true,
       "requires": {
         "@types/eslint-visitor-keys": "^1.0.0",
-        "@typescript-eslint/experimental-utils": "2.19.0",
+        "@typescript-eslint/experimental-utils": "2.22.0",
-        "@typescript-eslint/typescript-estree": "2.19.0",
+        "@typescript-eslint/typescript-estree": "2.22.0",
         "eslint-visitor-keys": "^1.1.0"
+      },
+      "dependencies": {
+        "@typescript-eslint/experimental-utils": {
+          "version": "2.22.0",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-2.22.0.tgz",
+          "integrity": "sha512-sJt1GYBe6yC0dWOQzXlp+tiuGglNhJC9eXZeC8GBVH98Zv9jtatccuhz0OF5kC/DwChqsNfghHx7OlIDQjNYAQ==",
+          "dev": true,
+          "requires": {
+            "@types/json-schema": "^7.0.3",
+            "@typescript-eslint/typescript-estree": "2.22.0",
+            "eslint-scope": "^5.0.0"
+          }
+        },
+        "@typescript-eslint/typescript-estree": {
+          "version": "2.22.0",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-2.22.0.tgz",
+          "integrity": "sha512-2HFZW2FQc4MhIBB8WhDm9lVFaBDy6h9jGrJ4V2Uzxe/ON29HCHBTj3GkgcsgMWfsl2U5as+pTOr30Nibaw7qRQ==",
+          "dev": true,
+          "requires": {
+            "debug": "^4.1.1",
+            "eslint-visitor-keys": "^1.1.0",
+            "glob": "^7.1.6",
+            "is-glob": "^4.0.1",
+            "lodash": "^4.17.15",
+            "semver": "^6.3.0",
+            "tsutils": "^3.17.1"
+          }
+        },
+        "semver": {
+          "version": "6.3.0",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
+          "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+          "dev": true
+        }
       }
     },
     "@typescript-eslint/typescript-estree": {
-      "version": "2.19.0",
+      "version": "2.22.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-2.19.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-2.22.0.tgz",
-      "integrity": "sha512-n6/Xa37k0jQdwpUszffi19AlNbVCR0sdvCs3DmSKMD7wBttKY31lhD2fug5kMD91B2qW4mQldaTEc1PEzvGu8w==",
+      "integrity": "sha512-2HFZW2FQc4MhIBB8WhDm9lVFaBDy6h9jGrJ4V2Uzxe/ON29HCHBTj3GkgcsgMWfsl2U5as+pTOr30Nibaw7qRQ==",
       "dev": true,
       "requires": {
         "debug": "^4.1.1",
@@ -847,9 +921,9 @@
       }
     },
     "@zeit/ncc": {
-      "version": "0.21.0",
+      "version": "0.21.1",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.0.tgz",
+      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.1.tgz",
-      "integrity": "sha512-RUMdvVK/w78oo+yBjruZltt0kJXYar2un/1bYQ2LuHG7GmFVm+QjxzEmySwREctaJdEnBvlMdUNWd9hXHxEI3g==",
+      "integrity": "sha512-M9WzgquSOt2nsjRkYM9LRylBLmmlwNCwYbm3Up3PDEshfvdmIfqpFNSK8EJvR18NwZjGHE5z2avlDtYQx2JQnw==",
       "dev": true
     },
     "JSONStream": {
@@ -2317,13 +2391,12 @@
       }
     },
     "eslint-plugin-jest": {
-      "version": "23.6.0",
+      "version": "23.8.2",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-23.6.0.tgz",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-23.8.2.tgz",
-      "integrity": "sha512-GH8AhcFXspOLqak7fqnddLXEJsrFyvgO8Bm60SexvKSn1+3rWYESnCiWUOCUcBTprNSDSE4CtAZdM4EyV6gPPw==",
+      "integrity": "sha512-xwbnvOsotSV27MtAe7s8uGWOori0nUsrXh2f1EnpmXua8sDfY6VZhHAhHg2sqK7HBNycRQExF074XSZ7DvfoFg==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/experimental-utils": "^2.5.0",
+        "@typescript-eslint/experimental-utils": "^2.5.0"
-        "micromatch": "^4.0.2"
       }
     },
     "eslint-scope": {
@@ -3359,9 +3432,9 @@
       "dev": true
     },
     "husky": {
-      "version": "4.2.1",
+      "version": "4.2.3",
-      "resolved": "https://registry.npmjs.org/husky/-/husky-4.2.1.tgz",
+      "resolved": "https://registry.npmjs.org/husky/-/husky-4.2.3.tgz",
-      "integrity": "sha512-Qa0lRreeIf4Tl92sSs42ER6qc3hzoyQPPorzOrFWfPEVbdi6LuvJEqWKPk905fOWIR76iBpp7ECZNIwk+a8xuQ==",
+      "integrity": "sha512-VxTsSTRwYveKXN4SaH1/FefRJYCtx+wx04sSVcOpD7N2zjoHxa+cEJ07Qg5NmV3HAK+IRKOyNVpi2YBIVccIfQ==",
       "dev": true,
       "requires": {
         "chalk": "^3.0.0",
@@ -4531,9 +4604,9 @@
       "dev": true
     },
     "lint-staged": {
-      "version": "10.0.7",
+      "version": "10.0.8",
-      "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-10.0.7.tgz",
+      "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-10.0.8.tgz",
-      "integrity": "sha512-Byj0F4l7GYUpYYHEqyFH69NiI6ICTg0CeCKbhRorL+ickbzILKUlZLiyCkljZV02wnoh7yH7PmFyYm9PRNwk9g==",
+      "integrity": "sha512-Oa9eS4DJqvQMVdywXfEor6F4vP+21fPHF8LUXgBbVWUSWBddjqsvO6Bv1LwMChmgQZZqwUvgJSHlu8HFHAPZmA==",
       "dev": true,
       "requires": {
         "chalk": "^3.0.0",
@@ -5149,9 +5222,9 @@
       }
     },
     "make-error": {
-      "version": "1.3.5",
+      "version": "1.3.6",
-      "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.5.tgz",
+      "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
-      "integrity": "sha512-c3sIjNUow0+8swNwVpqoH4YCShKNFkMaw6oH1mNS2haDZQqkeZFlHS3dhoeEbKKmJB4vXpJucU6oH75aDYeE9g==",
+      "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
       "dev": true
     },
     "makeerror": {
@@ -7351,9 +7424,9 @@
       "dev": true
     },
     "ts-jest": {
-      "version": "25.2.0",
+      "version": "25.2.1",
-      "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-25.2.0.tgz",
+      "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-25.2.1.tgz",
-      "integrity": "sha512-VaRdb0da46eorLfuHEFf0G3d+jeREcV+Wb/SvW71S4y9Oe8SHWU+m1WY/3RaMknrBsnvmVH0/rRjT8dkgeffNQ==",
+      "integrity": "sha512-TnntkEEjuXq/Gxpw7xToarmHbAafgCaAzOpnajnFC6jI7oo1trMzAHA04eWpc3MhV6+yvhE8uUBAmN+teRJh0A==",
       "dev": true,
       "requires": {
         "bs-logger": "0.x",
@@ -7365,24 +7438,7 @@
         "mkdirp": "0.x",
         "resolve": "1.x",
         "semver": "^5.5",
-        "yargs-parser": "10.x"
+        "yargs-parser": "^16.1.0"
-      },
-      "dependencies": {
-        "camelcase": {
-          "version": "4.1.0",
-          "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz",
-          "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=",
-          "dev": true
-        },
-        "yargs-parser": {
-          "version": "10.1.0",
-          "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-10.1.0.tgz",
-          "integrity": "sha512-VCIyR1wJoEBZUqk5PA+oOBF6ypbwh5aNB3I50guxAL/quggdfs4TtNHQrSazFA3fYZ+tEqfs0zIGlv0c/rgjbQ==",
-          "dev": true,
-          "requires": {
-            "camelcase": "^4.1.0"
-          }
-        }
       }
     },
     "tslib": {
@@ -7457,9 +7513,9 @@
       }
     },
     "typescript": {
-      "version": "3.7.5",
+      "version": "3.8.3",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.5.tgz",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.8.3.tgz",
-      "integrity": "sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==",
+      "integrity": "sha512-MYlEfn5VrLNsgudQTVJeNaQFUAI7DkhnOjdpAp4T+ku1TfQClewlbSuTVHiA+8skNBgaf02TL/kLOvig4y3G8w==",
       "dev": true
     },
     "uglify-js": {

package.json

@@ -1,11 +1,11 @@
 {
   "name": "actions-github-pages",
-  "version": "3.0.2",
+  "version": "3.5.1",
   "description": "GitHub Actions for GitHub Pages",
   "main": "lib/index.js",
   "engines": {
-    "node": ">=12.14.1",
+    "node": ">=12.16.1",
-    "npm": ">=6.13.7"
+    "npm": ">=6.14.2"
   },
   "scripts": {
     "lint": "eslint ./{src,__tests__}/**/*.ts",
@@ -50,26 +50,28 @@
   },
   "homepage": "https://github.com/peaceiris/actions-gh-pages#readme",
   "dependencies": {
-    "@actions/core": "^1.2.2",
+    "@actions/core": "^1.2.3",
     "@actions/exec": "^1.0.3",
-    "@actions/github": "^2.1.0",
+    "@actions/github": "^2.1.1",
     "@actions/io": "^1.0.2"
   },
   "devDependencies": {
-    "@types/jest": "^25.1.1",
+    "@types/jest": "^25.1.4",
-    "@types/node": "^13.7.0",
+    "@types/js-yaml": "^3.12.2",
-    "@typescript-eslint/eslint-plugin": "^2.19.0",
+    "@types/node": "~12",
-    "@typescript-eslint/parser": "^2.19.0",
+    "@typescript-eslint/eslint-plugin": "^2.22.0",
-    "@zeit/ncc": "^0.21.0",
+    "@typescript-eslint/parser": "^2.22.0",
+    "@zeit/ncc": "^0.21.1",
     "eslint": "^6.8.0",
-    "eslint-plugin-jest": "^23.6.0",
+    "eslint-plugin-jest": "^23.8.2",
-    "husky": "^4.2.1",
+    "husky": "^4.2.3",
     "jest": "^25.1.0",
     "jest-circus": "^25.1.0",
-    "lint-staged": "^10.0.7",
+    "js-yaml": "^3.13.1",
+    "lint-staged": "^10.0.8",
     "prettier": "1.19.1",
     "standard-version": "^7.1.0",
-    "ts-jest": "^25.2.0",
+    "ts-jest": "^25.2.1",
-    "typescript": "^3.7.5"
+    "typescript": "^3.8.3"
   }
 }

release.sh

@@ -3,12 +3,23 @@
 # fail on unset variables and command errors
 set -eu -o pipefail # -x: is for debugging
 
-if [ "$(git branch --show-current)" != "master" ]; then
+CURRENT_BRANCH="$(git branch --show-current)"
-  echo "$0: Current branch is not master" 1>&2
+if [ "${CURRENT_BRANCH}" != "master" ]; then
-  exit 1
+  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
 
-RELEASE_TYPE_LIST="prerelease prepatch patch preminor minor major premajor"
 if command -v fzf; then
   RELEASE_TYPE=$(echo "${RELEASE_TYPE_LIST}" | tr ' ' '\n' | fzf --layout=reverse)
 else
@@ -26,9 +37,13 @@ if [ "${res}" = "n" ]; then
 fi
 
 git fetch origin
-git pull origin master
+if [ "${CURRENT_BRANCH}" != "master" ]; then
-git tag -d v3 || true
+  git pull origin "${CURRENT_BRANCH}"
-git pull origin --tags
+else
+  git pull origin master
+  git tag -d v3 || true
+  git pull origin --tags
+fi
 
 npm ci
 
@@ -43,6 +58,11 @@ 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 master
 git push origin "${TAG_NAME}"

src/get-inputs.ts

@@ -1,29 +1,50 @@
 import * as core from '@actions/core';
 import {Inputs} from './interfaces';
 
-function showInputs(inps: Inputs): void {
+export function showInputs(inps: Inputs): void {
+  let authMethod = '';
   if (inps.DeployKey) {
-    core.info(`[INFO] DeployKey: true`);
+    authMethod = 'DeployKey';
   } else if (inps.GithubToken) {
-    core.info(`[INFO] GithubToken: true`);
+    authMethod = 'GithubToken';
   } else if (inps.PersonalToken) {
-    core.info(`[INFO] PersonalToken: true`);
+    authMethod = 'PersonalToken';
   }
 
-  core.info(`[INFO] PublishBranch: ${inps.PublishBranch}`);
+  core.info(`\
-  core.info(`[INFO] PublishDir: ${inps.PublishDir}`);
+[INFO] ${authMethod}: true
-  core.info(`[INFO] ExternalRepository: ${inps.ExternalRepository}`);
+[INFO] PublishBranch: ${inps.PublishBranch}
-  core.info(`[INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}`);
+[INFO] PublishDir: ${inps.PublishDir}
-  core.info(`[INFO] KeepFiles: ${inps.KeepFiles}`);
+[INFO] ExternalRepository: ${inps.ExternalRepository}
-  core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
+[INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}
-  core.info(`[INFO] UserEmail: ${inps.UserEmail}`);
+[INFO] KeepFiles: ${inps.KeepFiles}
-  core.info(`[INFO] UserEmail: ${inps.UserEmail}`);
+[INFO] ForceOrphan: ${inps.ForceOrphan}
-  core.info(`[INFO] CommitMessage: ${inps.CommitMessage}`);
+[INFO] UserName: ${inps.UserName}
-  core.info(`[INFO] TagName: ${inps.TagName}`);
+[INFO] UserEmail: ${inps.UserEmail}
-  core.info(`[INFO] TagMessage: ${inps.TagMessage}`);
+[INFO] CommitMessage: ${inps.CommitMessage}
+[INFO] TagName: ${inps.TagName}
+[INFO] TagMessage: ${inps.TagMessage}
+[INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
+[INFO] CNAME: ${inps.CNAME}
+`);
 }
 
 export function getInputs(): Inputs {
+  let useBuiltinJekyll = false;
+
+  const enableJekyll: boolean =
+    (core.getInput('enable_jekyll') || 'false').toUpperCase() === 'TRUE';
+  const disableNoJekyll: boolean =
+    (core.getInput('disable_nojekyll') || 'false').toUpperCase() === 'TRUE';
+
+  if (enableJekyll && disableNoJekyll) {
+    throw new Error(`Use either of enable_jekyll or disable_nojekyll`);
+  } else if (enableJekyll) {
+    useBuiltinJekyll = true;
+  } else if (disableNoJekyll) {
+    useBuiltinJekyll = true;
+  }
+
   const inps: Inputs = {
     DeployKey: core.getInput('deploy_key'),
     GithubToken: core.getInput('github_token'),
@@ -41,10 +62,10 @@ export function getInputs(): Inputs {
     UserEmail: core.getInput('user_email'),
     CommitMessage: core.getInput('commit_message'),
     TagName: core.getInput('tag_name'),
-    TagMessage: core.getInput('tag_message')
+    TagMessage: core.getInput('tag_message'),
+    DisableNoJekyll: useBuiltinJekyll,
+    CNAME: core.getInput('cname')
   };
 
-  showInputs(inps);
-
   return inps;
 }

src/git-utils.ts

@@ -5,13 +5,7 @@ import * as io from '@actions/io';
 import path from 'path';
 import fs from 'fs';
 import {Inputs, CmdResult} from './interfaces';
-import {getHomeDir} from './utils';
+import {createWorkDir} from './utils';
-
-export async function createWorkDir(workDirName: string): Promise<void> {
-  await io.mkdirP(workDirName);
-  core.debug(`workDir was created: ${workDirName}`);
-  return;
-}
 
 export async function createBranchForce(branch: string): Promise<void> {
   await exec.exec('git', ['init']);
@@ -38,8 +32,11 @@ export async function copyAssets(
   return;
 }
 
-export async function setRepo(inps: Inputs, remoteURL: string): Promise<void> {
+export async function setRepo(
-  const workDir = path.join(getHomeDir(), 'actions_github_pages');
+  inps: Inputs,
+  remoteURL: string,
+  workDir: string
+): Promise<void> {
   const publishDir = path.join(
     `${process.env.GITHUB_WORKSPACE}`,
     inps.PublishDir
@@ -65,36 +62,41 @@ export async function setRepo(inps: Inputs, remoteURL: string): Promise<void> {
       }
     }
   };
-  result.exitcode = await exec.exec(
-    'git',
-    [
-      'clone',
-      '--depth=1',
-      '--single-branch',
-      '--branch',
-      inps.PublishBranch,
-      remoteURL,
-      workDir
-    ],
-    options
-  );
 
-  process.chdir(workDir);
+  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', '*']);
+      }
 
-  if (result.exitcode === 0) {
+      await copyAssets(publishDir, workDir);
-    if (inps.KeepFiles) {
+      return;
-      core.info('[INFO] Keep existing files');
     } else {
-      await exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+      throw new Error(`Failed to clone remote branch ${inps.PublishBranch}`);
     }
-
+  } catch (e) {
-    await copyAssets(publishDir, workDir);
-    return;
-  } else {
     core.info(
       `[INFO] first deployment, create new branch ${inps.PublishBranch}`
     );
+    core.info(e.message);
     await createWorkDir(workDir);
+    process.chdir(workDir);
     await createBranchForce(inps.PublishBranch);
     await copyAssets(publishDir, workDir);
     return;
@@ -154,7 +156,7 @@ export async function commit(
     }
   } catch (e) {
     core.info('[INFO] skip commit');
-    core.debug(`[INFO] skip commit ${e}`);
+    core.debug(`[INFO] skip commit ${e.message}`);
   }
 }
 

src/index.ts

@@ -5,6 +5,6 @@ import * as main from './main';
   try {
     await main.run();
   } catch (e) {
-    core.setFailed(`Action failed with "${e}"`);
+    core.setFailed(`Action failed with "${e.message}"`);
   }
 })();

src/interfaces.ts

@@ -13,6 +13,8 @@ export interface Inputs {
   readonly CommitMessage: string;
   readonly TagName: string;
   readonly TagMessage: string;
+  readonly DisableNoJekyll: boolean;
+  readonly CNAME: string;
 }
 
 export interface CmdResult {

src/main.ts

@@ -1,25 +1,33 @@
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 import {Inputs} from './interfaces';
-import {getInputs} from './get-inputs';
+import {showInputs, 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();
+    showInputs(inps);
 
     await git.setConfig(inps.UserName, inps.UserEmail);
 
     const remoteURL = await setTokens(inps);
     core.debug(`[INFO] remoteURL: ${remoteURL}`);
 
-    await git.setRepo(inps, 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`);
+      core.info(`[INFO] ${e.message}`);
     }
     await exec.exec('git', ['remote', 'add', 'origin', remoteURL]);
     await exec.exec('git', ['add', '--all']);
@@ -31,10 +39,11 @@ export async function run(): Promise<void> {
     );
     await git.push(inps.PublishBranch, inps.ForceOrphan);
     await git.pushTag(inps.TagName, inps.TagMessage);
-    core.info('[INFO] successfully deployed');
+
+    core.info('[INFO] Action successfully completed');
 
     return;
   } catch (e) {
-    throw new Error(e);
+    throw new Error(e.message);
   }
 }

src/set-tokens.ts

@@ -7,27 +7,7 @@ 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 getHomeDir(): string {
-  let homedir = '';
-
-  if (process.platform === 'win32') {
-    homedir = process.env['USERPROFILE'] || 'C:\\';
-  } else {
-    homedir = `${process.env.HOME}`;
-  }
-
-  core.debug(`homeDir: ${homedir}`);
-
-  return homedir;
-}
-
-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,
@@ -35,7 +15,7 @@ export async function setSSHKey(
 ): Promise<string> {
   core.info('[INFO] setup SSH deploy key');
 
-  const homeDir = getHomeDir();
+  const homeDir = await getHomeDir();
   const sshDir = path.join(homeDir, '.ssh');
   await io.mkdirP(sshDir);
   await exec.exec('chmod', ['700', sshDir]);
@@ -79,68 +59,82 @@ Host github
   return `git@github.com:${publishRepo}.git`;
 }
 
-export async function setGithubToken(
+export function setGithubToken(
-  inps: Inputs,
+  githubToken: string,
-  publishRepo: string
+  publishRepo: string,
-): Promise<string> {
+  publishBranch: string,
+  externalRepository: string,
+  ref: string,
+  eventName: string
+): string {
   core.info('[INFO] setup GITHUB_TOKEN');
 
-  const context = github.context;
+  core.debug(`ref: ${ref}`);
-  const payload = github.context.payload;
+  core.debug(`eventName: ${eventName}`);
-  core.debug(`ref: ${context.ref}`);
-  core.debug(`eventName: ${context.eventName}`);
-  core.debug(`private: ${payload.repository?.private}`);
   let isProhibitedBranch = false;
 
-  const ref = context.ref;
+  if (eventName === 'push') {
-  if (context.eventName === 'push') {
+    isProhibitedBranch = ref.includes(`refs/heads/${publishBranch}`);
-    isProhibitedBranch = ref.includes(`refs/heads/${inps.PublishBranch}`);
     if (isProhibitedBranch) {
-      throw new Error(
+      throw new Error(`You deploy from ${publishBranch} to ${publishBranch}`);
-        `You deploy from ${inps.PublishBranch} to ${inps.PublishBranch}`
-      );
     }
-  } else if (context.eventName === 'pull_request') {
-    // TODO: support pull_request event
-    throw new Error('This action does not support pull_request event now.');
   }
 
-  const isPrivateRepository = payload.repository?.private;
+  if (externalRepository) {
-  if (inps.ExternalRepository) {
     throw new Error(
       'GITHUB_TOKEN does not support to push to an external repository'
     );
   }
-  if (isPrivateRepository === false) {
-    core.warning(
-      'GITHUB_TOKEN does not support to trigger the GitHub Pages build event on a public repository'
-    );
-  }
 
-  return `https://x-access-token:${inps.GithubToken}@github.com/${publishRepo}.git`;
+  return `https://x-access-token:${githubToken}@github.com/${publishRepo}.git`;
 }
 
-export async function setPersonalToken(
+export function setPersonalToken(
-  inps: Inputs,
+  personalToken: string,
   publishRepo: string
-): Promise<string> {
+): string {
   core.info('[INFO] setup personal access token');
-  return `https://x-access-token:${inps.PersonalToken}@github.com/${publishRepo}.git`;
+  return `https://x-access-token:${personalToken}@github.com/${publishRepo}.git`;
+}
+
+export function getPublishRepo(
+  externalRepository: string,
+  owner: string,
+  repo: string
+): string {
+  if (externalRepository) {
+    return externalRepository;
+  }
+  return `${owner}/${repo}`;
 }
 
 export async function setTokens(inps: Inputs): Promise<string> {
   try {
-    const publishRepo = setPublishRepo(inps);
+    const publishRepo = getPublishRepo(
+      inps.ExternalRepository,
+      github.context.repo.owner,
+      github.context.repo.repo
+    );
     if (inps.DeployKey) {
       return setSSHKey(inps, publishRepo);
     } else if (inps.GithubToken) {
-      return setGithubToken(inps, publishRepo);
+      const context = github.context;
+      const ref = context.ref;
+      const eventName = context.eventName;
+      return setGithubToken(
+        inps.GithubToken,
+        publishRepo,
+        inps.PublishBranch,
+        inps.ExternalRepository,
+        ref,
+        eventName
+      );
     } else if (inps.PersonalToken) {
-      return setPersonalToken(inps, publishRepo);
+      return setPersonalToken(inps.PersonalToken, publishRepo);
     } else {
       throw new Error('not found deploy key or tokens');
     }
   } catch (e) {
-    throw new Error(e);
+    throw new Error(e.message);
   }
 }

src/utils.ts

@@ -1,6 +1,9 @@
 import * as core from '@actions/core';
+import * as io from '@actions/io';
+import path from 'path';
+import fs from 'fs';
 
-export function getHomeDir(): string {
+export async function getHomeDir(): Promise<string> {
   let homedir = '';
 
   if (process.platform === 'win32') {
@@ -13,3 +16,49 @@ export function getHomeDir(): string {
 
   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}`);
+}