chore(release): 3.6.1

cf. https://github.com/actions/toolkit/blob/master/docs/commands.md

.dependabot/config.yml

@@ -2,8 +2,29 @@ version: 1
 update_configs:
   - package_manager: "javascript"
     directory: "/"
-    update_schedule: "daily"
+    update_schedule: "live"
     default_labels:
       - "dependencies"
     commit_message:
       prefix: "deps"
+    automerged_updates:
+      - match:
+          dependency_type: "development"
+          # Supported dependency types:
+          # - "development"
+          # - "production"
+          # - "all"
+          update_type: "all"
+          # Supported updates to automerge:
+          # - "security:patch"
+          #   SemVer patch update that fixes a known security vulnerability
+          # - "semver:patch"
+          #   SemVer patch update, e.g. > 1.x && 1.0.1 to 1.0.3
+          # - "semver:minor"
+          #   SemVer minor update, e.g. > 1.x && 2.1.4 to 2.3.1
+          # - "in_range"
+          #   matching the version requirement in your package manifest
+          # - "all"
+      - match:
+          dependency_type: "production"
+          update_type: "semver:patch"

.github/ISSUE_TEMPLATE/1_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/ISSUE_TEMPLATE/2_bug_report.md

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

.github/ISSUE_TEMPLATE/3_proposal.md

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

.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/workflows/dev-image.yml

@@ -0,0 +1,37 @@
+name: 'Dev Image CI'
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '.github/workflows/dev-image.yml'
+      - '.dockerignore'
+      - '.nvmrc'
+      - 'Dockerfile'
+      - 'Makefile'
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths:
+      - '.github/workflows/dev-image.yml'
+      - '.dockerignore'
+      - '.nvmrc'
+      - 'Dockerfile'
+      - 'Makefile'
+
+jobs:
+  skipci:
+    runs-on: ubuntu-18.04
+    steps:
+      - run: echo "[skip ci] ${{ contains(github.event.head_commit.message, '[skip ci]') }}"
+
+  dev-image-test:
+    runs-on: ubuntu-18.04
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+    steps:
+      - uses: actions/checkout@v2
+      - run: make build
+      - run: make cirun cmd="npm ci"
+      - run: make ciall

.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"
-          curl -fsSL https://github.com/github/hub/raw/40e421edd2c63d57bb8daa4bb9bbdfa21e8becf9/script/get | bash -s "${HUB_VERSION}"
+          export HUB_VERSION="2.14.2"
+          curl -fsSL https://github.com/github/hub/raw/8d91904208171b013f9a9d1175f4ab39068db047/script/get | bash -s "${HUB_VERSION}"
 
       - name: Create release
         env:

.github/workflows/stale.yml

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

.github/workflows/test-action.yml

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

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
   skipci:
     runs-on: ubuntu-18.04
     steps:
-      - run: echo "[Skip CI] ${{ contains(github.event.head_commit.message, '[skip ci]') }}"
+      - run: echo "[skip ci] ${{ contains(github.event.head_commit.message, '[skip ci]') }}"
 
   test:
     runs-on: ${{ matrix.os }}
@@ -26,11 +26,17 @@ jobs:
       matrix:
         os:
           - 'ubuntu-18.04'
+          - 'ubuntu-16.04'
           - 'macos-latest'
           - 'windows-latest'
     steps:
       - uses: actions/checkout@v2
 
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "${GITHUB_CONTEXT}"
+
       - name: Read .nvmrc
         run: echo "::set-output name=NVMRC::$(cat .nvmrc)"
         id: nvm
@@ -51,25 +57,195 @@ jobs:
       - run: npm ci
 
       - name: Run prettier
-        if: startsWith(matrix.os, 'ubuntu')
+        if: startsWith(matrix.os, 'ubuntu-18.04')
         run: npm run format:check
 
       - name: Run eslint
-        if: startsWith(matrix.os, 'ubuntu')
+        if: startsWith(matrix.os, 'ubuntu-18.04')
         run: npm run lint
 
-      - name: Run ncc
-        if: startsWith(matrix.os, 'ubuntu')
-        run: npm run build
-
       - run: npm test
 
       - name: Upload test coverage as artifact
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v2
         with:
-          name: coverage
+          name: coverage-${{ matrix.os }}
           path: coverage
 
       - uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Run ncc
+        run: npm run build
+
+      - name: Remove lint-staged husky
+        if: github.ref == 'refs/heads/master'
+        run: |
+          npm uninstall lint-staged husky
+          git checkout package-lock.json package.json
+
+      - name: Setup mdBook
+        if: github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.3.7'
+
+      - name: Build site
+        if: github.ref == 'refs/heads/master'
+        working-directory: ./test_projects/mdbook
+        run: mdbook build
+
+      - name: Deploy
+        if: |
+          startsWith(matrix.os, 'ubuntu-18.04') &&
+          github.ref == 'refs/heads/master'
+        uses: ./
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          # github_token: ${{ secrets.GITHUB_TOKEN }}
+          # publish_branch: gh-pages
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          # keep_files: true
+          # force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          # commit_message: ${{ github.event.head_commit.message }}
+          cname: 'actions-gh-pages.peaceiris.com'
+
+      - name: Deploy
+        if: |
+          startsWith(matrix.os, 'ubuntu-16.04') &&
+          github.ref == 'refs/heads/master'
+        uses: ./
+        with:
+          # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages-ubuntu-16.04
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          keep_files: true
+          force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          full_commit_message: ${{ github.event.head_commit.message }}
+
+      - name: Deploy
+        if: |
+          startsWith(matrix.os, 'macos') &&
+          github.ref == 'refs/heads/master'
+        uses: ./
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          # github_token: ${{ secrets.GITHUB_TOKEN }}
+          # personal_token: ${{ secrets.PERSONAL_TOKEN }}
+          publish_branch: gh-pages-macos
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          # keep_files: true
+          # force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          # commit_message: ${{ github.event.head_commit.message }}
+
+      - name: Deploy
+        if: |
+          startsWith(matrix.os, 'windows') &&
+          github.ref == 'refs/heads/master'
+        uses: ./
+        with:
+          # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # personal_token: ${{ secrets.PERSONAL_TOKEN }}
+          publish_branch: gh-pages-windows
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          # keep_files: true
+          # force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          # commit_message: ${{ github.event.head_commit.message }}
+
+  test-ubuntu-2004:
+    runs-on: 'ubuntu-18.04'
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+    container:
+      image: 'ubuntu:20.04'
+    steps:
+      - name: Install deps
+        run: |
+          apt update
+          apt install -y software-properties-common
+          add-apt-repository ppa:git-core/ppa
+          apt update
+          apt install -y \
+            git \
+            ssh
+
+      - uses: actions/checkout@v2
+
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "${GITHUB_CONTEXT}"
+
+      - name: Read .nvmrc
+        run: echo "::set-output name=NVMRC::$(cat .nvmrc)"
+        id: nvm
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '${{ steps.nvm.outputs.NVMRC }}'
+
+      - run: npm i -g npm
+
+      - name: Dump version
+        run: |
+          node -v
+          npm --version
+          git --version
+
+      - run: npm ci
+      - run: npm test
+
+      - name: Run ncc
+        run: npm run build
+
+      - name: Remove lint-staged husky
+        if: github.ref == 'refs/heads/master'
+        run: |
+          npm uninstall lint-staged husky
+          git checkout package-lock.json package.json
+
+      - name: Setup mdBook
+        if: github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.3.7'
+
+      - name: Build site
+        if: github.ref == 'refs/heads/master'
+        working-directory: ./test_projects/mdbook
+        run: mdbook build
+
+      - name: Deploy
+        if: github.ref == 'refs/heads/master'
+        uses: ./
+        with:
+          # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages-ubuntu-20.04
+          publish_dir: ./test_projects/mdbook/book
+          # external_repository: ''
+          allow_empty_commit: true
+          # keep_files: true
+          # force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          # commit_message: ${{ github.event.head_commit.message }}

.nvmrc

@@ -1 +1 @@
-12.16.1
+12.16.3

CHANGELOG.md

@@ -2,6 +2,392 @@
 
 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.6.1](https://github.com/peaceiris/actions-gh-pages/compare/v3.6.0...v3.6.1) (2020-05-04)
+
+
+### docs
+
+* Add example image for commit_message ([f559ed8](https://github.com/peaceiris/actions-gh-pages/commit/f559ed8889a7ba2364757bc7a97b0491263147ff))
+
+### feat
+
+* Fold logs using core.startGroup() (#277) ([db3e60d](https://github.com/peaceiris/actions-gh-pages/commit/db3e60d230c7ebcd5342990f0ffc5af0ed1f4296)), closes [#277](https://github.com/peaceiris/actions-gh-pages/issues/277)
+
+### test
+
+* Add test case for getCommitMessage() (#276) ([5041814](https://github.com/peaceiris/actions-gh-pages/commit/504181401bb2df2de020ed72a7f2b4f8942bcb77)), closes [#276](https://github.com/peaceiris/actions-gh-pages/issues/276)
+
+
+
+# [3.6.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.10...v3.6.0) (2020-05-04)
+
+
+### chore
+
+* Enhance style ([750c807](https://github.com/peaceiris/actions-gh-pages/commit/750c807fa1ecf9d3d455cfd0fb5533442c660a1e))
+
+### ci
+
+* Add test-ubuntu-20.04 job (#270) ([7501463](https://github.com/peaceiris/actions-gh-pages/commit/75014632413b319cb87db5b3e54bba2d6a21ac05)), closes [#270](https://github.com/peaceiris/actions-gh-pages/issues/270) [#268](https://github.com/peaceiris/actions-gh-pages/issues/268)
+* use github_token ([9d27fac](https://github.com/peaceiris/actions-gh-pages/commit/9d27fac8dcdc50937d59b3068c59acf257ad2398))
+
+### deps
+
+* bump @actions/core from 1.2.3 to 1.2.4 (#265) ([dd1933a](https://github.com/peaceiris/actions-gh-pages/commit/dd1933a7b4b77a06b1995b0e8c40b6c219f32550)), closes [#265](https://github.com/peaceiris/actions-gh-pages/issues/265)
+* bump jest from 25.5.2 to 25.5.3 (#267) ([e782e1d](https://github.com/peaceiris/actions-gh-pages/commit/e782e1d32332c2e99058a039dd5caaf0533d0af6)), closes [#267](https://github.com/peaceiris/actions-gh-pages/issues/267)
+* bump jest from 25.5.3 to 25.5.4 (#272) ([ae34186](https://github.com/peaceiris/actions-gh-pages/commit/ae34186caa187c2960bae6d656f6ef69c6aa0fba)), closes [#272](https://github.com/peaceiris/actions-gh-pages/issues/272)
+* bump jest-circus from 25.5.2 to 25.5.3 (#266) ([c12a4b1](https://github.com/peaceiris/actions-gh-pages/commit/c12a4b1908457ab10af84e0947b66af3f868790c)), closes [#266](https://github.com/peaceiris/actions-gh-pages/issues/266)
+* bump jest-circus from 25.5.3 to 25.5.4 (#271) ([a5d411b](https://github.com/peaceiris/actions-gh-pages/commit/a5d411bf285983883daecb16787a8f6549da66d8)), closes [#271](https://github.com/peaceiris/actions-gh-pages/issues/271)
+* bump lint-staged from 10.2.0 to 10.2.1 (#264) ([0809306](https://github.com/peaceiris/actions-gh-pages/commit/08093066ac77639e402a4b60492a7759c395ba36)), closes [#264](https://github.com/peaceiris/actions-gh-pages/issues/264)
+* bump lint-staged from 10.2.1 to 10.2.2 (#269) ([b9cccec](https://github.com/peaceiris/actions-gh-pages/commit/b9cccec41e2e47ef704d34a7409dc07a50e32d46)), closes [#269](https://github.com/peaceiris/actions-gh-pages/issues/269)
+
+### feat
+
+* Add full_commit_message (#275) ([0b7411e](https://github.com/peaceiris/actions-gh-pages/commit/0b7411e2cf05b033f6766798560d02e932e01bd2)), closes [#275](https://github.com/peaceiris/actions-gh-pages/issues/275) [#274](https://github.com/peaceiris/actions-gh-pages/issues/274)
+
+
+
+## [3.5.10](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.9...v3.5.10) (2020-04-30)
+
+
+### deps
+
+* bump jest from 25.5.1 to 25.5.2 (#260) ([714f710](https://github.com/peaceiris/actions-gh-pages/commit/714f7109225b609d3303bb0cd6f459690a9165b6)), closes [#260](https://github.com/peaceiris/actions-gh-pages/issues/260)
+* bump jest-circus from 25.5.1 to 25.5.2 (#259) ([813be06](https://github.com/peaceiris/actions-gh-pages/commit/813be0645e175e6e475ada4f9cc922daeeade00a)), closes [#259](https://github.com/peaceiris/actions-gh-pages/issues/259)
+
+### docs
+
+* Add ubuntu-16.04 ([d9f616f](https://github.com/peaceiris/actions-gh-pages/commit/d9f616f4a278b6c334ce6dea09e69ba698459b38)), closes [#263](https://github.com/peaceiris/actions-gh-pages/issues/263)
+* bump actions/setup-python from v1 to v2 (#262) ([029c1a0](https://github.com/peaceiris/actions-gh-pages/commit/029c1a08f9594e3b2c581d78c258cc8e9c66f96c)), closes [#262](https://github.com/peaceiris/actions-gh-pages/issues/262)
+* bump python from 3.6 to 3.8 ([eafac7a](https://github.com/peaceiris/actions-gh-pages/commit/eafac7a3ef405ea76543c2c7995b64a19a1695c0))
+* change to job level defaults ([20d80bc](https://github.com/peaceiris/actions-gh-pages/commit/20d80bcd8cdfda9728f3c0befe2aa5052209ea50))
+* Enhance Python workflow example (#261) ([e4462d9](https://github.com/peaceiris/actions-gh-pages/commit/e4462d9bb679154cb07cca446c8e12c692610838)), closes [#261](https://github.com/peaceiris/actions-gh-pages/issues/261)
+* Enhance Supported Platforms ([91e6658](https://github.com/peaceiris/actions-gh-pages/commit/91e6658ef01bbd482a965675988a765faad5fce5))
+
+### feat
+
+* Support ubuntu-16.04 (#263) ([e76c874](https://github.com/peaceiris/actions-gh-pages/commit/e76c874d85f0c0e45f3602fe4a85a15feb87610c)), closes [#263](https://github.com/peaceiris/actions-gh-pages/issues/263)
+
+
+
+## [3.5.9](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.8...v3.5.9) (2020-04-29)
+
+
+### chore
+
+* bump node from 12.16.2 to 12.16.3 ([e5aa21b](https://github.com/peaceiris/actions-gh-pages/commit/e5aa21b8a847df106ce694432a6cac78300266a3))
+
+### deps
+
+* [security] bump @actions/http-client from 1.0.6 to 1.0.8 (#258) ([d217882](https://github.com/peaceiris/actions-gh-pages/commit/d2178821cb5968f5b7c818210297f3dbeea3114c)), closes [#258](https://github.com/peaceiris/actions-gh-pages/issues/258)
+* bump @actions/exec from 1.0.3 to 1.0.4 (#254) ([6cb5962](https://github.com/peaceiris/actions-gh-pages/commit/6cb5962c014ba1196680337447c834590d907bde)), closes [#254](https://github.com/peaceiris/actions-gh-pages/issues/254)
+* bump jest from 25.5.0 to 25.5.1 (#257) ([6462e1b](https://github.com/peaceiris/actions-gh-pages/commit/6462e1bf5e8ba9325ae66bacba198b12c7e101ed)), closes [#257](https://github.com/peaceiris/actions-gh-pages/issues/257)
+* bump jest-circus from 25.5.0 to 25.5.1 (#256) ([051ddfc](https://github.com/peaceiris/actions-gh-pages/commit/051ddfc79a0bbbdd8e623367741645052c63fb9a)), closes [#256](https://github.com/peaceiris/actions-gh-pages/issues/256)
+* bump node from 12.16.2 to 12.16.3 (#255) ([f191fb8](https://github.com/peaceiris/actions-gh-pages/commit/f191fb81878aaa8657d346e9b3a97a4ad625939d)), closes [#255](https://github.com/peaceiris/actions-gh-pages/issues/255)
+* bump prettier from 2.0.4 to 2.0.5 (#253) ([33b82d2](https://github.com/peaceiris/actions-gh-pages/commit/33b82d2be041389aa51ca38f09cf6e79a9129035)), closes [#253](https://github.com/peaceiris/actions-gh-pages/issues/253)
+
+
+
+## [3.5.8](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.7...v3.5.8) (2020-04-29)
+
+
+### chore
+
+* Add issue priority [skip ci] ([eda4527](https://github.com/peaceiris/actions-gh-pages/commit/eda4527addb918b2101150ebb39fcf433918edaa))
+* Add issue priority [skip ci] ([af61d81](https://github.com/peaceiris/actions-gh-pages/commit/af61d81606e4fc7e288136ff2d253e2bc55c4f48))
+* enhance about [skip ci] ([1139364](https://github.com/peaceiris/actions-gh-pages/commit/1139364d4c33266789f7b3325cf9a44a8547dfd2))
+* update [skip ci] ([86114bb](https://github.com/peaceiris/actions-gh-pages/commit/86114bb2c7af49107a982228b5bdb03680d01f4d))
+
+### ci
+
+* Add hook for doctoc (#244) ([e3404eb](https://github.com/peaceiris/actions-gh-pages/commit/e3404eb04b31f2987120c926fea07b0213caebd8)), closes [#244](https://github.com/peaceiris/actions-gh-pages/issues/244)
+
+### deps
+
+* bump @types/node from 12.12.35 to 12.12.36 (#238) ([b7c9581](https://github.com/peaceiris/actions-gh-pages/commit/b7c9581509f430da7d5fd97e37245a2d0a66b564)), closes [#238](https://github.com/peaceiris/actions-gh-pages/issues/238)
+* bump @types/node from 12.12.36 to 12.12.37 (#251) ([7b01d76](https://github.com/peaceiris/actions-gh-pages/commit/7b01d765e76fa62e2452fd444f2b4c27a2a93821)), closes [#251](https://github.com/peaceiris/actions-gh-pages/issues/251)
+* bump @typescript-eslint/eslint-plugin from 2.28.0 to 2.30.0 (#252) ([f97b3d2](https://github.com/peaceiris/actions-gh-pages/commit/f97b3d256ec802bf086d5c96dcb299a63b38f705)), closes [#252](https://github.com/peaceiris/actions-gh-pages/issues/252)
+* bump @typescript-eslint/parser from 2.28.0 to 2.30.0 (#249) ([28e7732](https://github.com/peaceiris/actions-gh-pages/commit/28e7732e93caf2520c542d47eb7482a09d92399d)), closes [#249](https://github.com/peaceiris/actions-gh-pages/issues/249)
+* bump git from 2.26.1 to 2.26.2 (#246) ([db7681d](https://github.com/peaceiris/actions-gh-pages/commit/db7681db4d6bba0e054efa7da8d6494f40aa74dd)), closes [#246](https://github.com/peaceiris/actions-gh-pages/issues/246)
+* bump jest from 25.3.0 to 25.5.0 (#248) ([390b063](https://github.com/peaceiris/actions-gh-pages/commit/390b063535b4dc9533b19e2bdc0a5c756725bcd3)), closes [#248](https://github.com/peaceiris/actions-gh-pages/issues/248)
+* bump jest-circus from 25.3.0 to 25.5.0 (#247) ([50bcf7b](https://github.com/peaceiris/actions-gh-pages/commit/50bcf7b81dbedbab7f9d8c9cebc15c1d63724e52)), closes [#247](https://github.com/peaceiris/actions-gh-pages/issues/247)
+* bump lint-staged from 10.1.3 to 10.1.4 (#237) ([fd97637](https://github.com/peaceiris/actions-gh-pages/commit/fd976371344295a7f93bf199bc5557ef179ccb8c)), closes [#237](https://github.com/peaceiris/actions-gh-pages/issues/237)
+* bump lint-staged from 10.1.4 to 10.1.5 (#240) ([cfc119f](https://github.com/peaceiris/actions-gh-pages/commit/cfc119fff765ff9d58364aaacc6f3eeda2cfa803)), closes [#240](https://github.com/peaceiris/actions-gh-pages/issues/240)
+* bump lint-staged from 10.1.5 to 10.1.6 (#241) ([c1bc06c](https://github.com/peaceiris/actions-gh-pages/commit/c1bc06c3e6c64d6663aaaddce19c3092f44fee76)), closes [#241](https://github.com/peaceiris/actions-gh-pages/issues/241)
+* bump lint-staged from 10.1.6 to 10.2.0 (#250) ([4976317](https://github.com/peaceiris/actions-gh-pages/commit/4976317340cc18cda0238fb97829a0faaa845961)), closes [#250](https://github.com/peaceiris/actions-gh-pages/issues/250)
+* bump ts-jest from 25.3.1 to 25.4.0 (#236) ([f69bcb9](https://github.com/peaceiris/actions-gh-pages/commit/f69bcb9ae88328fdbf841072c8d6273cd64775d0)), closes [#236](https://github.com/peaceiris/actions-gh-pages/issues/236)
+
+### docs
+
+* Add publish_branch and publish_dir (#239) ([4b0ac94](https://github.com/peaceiris/actions-gh-pages/commit/4b0ac9453b6b8c117d2d477feec9438cbadde554)), closes [#239](https://github.com/peaceiris/actions-gh-pages/issues/239)
+* Enhance cache key (#235) ([f1ebad9](https://github.com/peaceiris/actions-gh-pages/commit/f1ebad9abbd9a38f40b3bf1731c8f24d11933c7f)), closes [#235](https://github.com/peaceiris/actions-gh-pages/issues/235)
+* Enhance Docusaurus example workflow (#234) ([63cdebd](https://github.com/peaceiris/actions-gh-pages/commit/63cdebd96bf13f045ac949edf7242044ecfef525)), closes [#234](https://github.com/peaceiris/actions-gh-pages/issues/234)
+* Enhance the Tips and FAQ section ([1511f85](https://github.com/peaceiris/actions-gh-pages/commit/1511f85febf4d985083555b7e644fc43582ec4ee))
+* update ([8632fea](https://github.com/peaceiris/actions-gh-pages/commit/8632feabc7064b8023ffa7da92bf6d91cf83a0fe))
+* update ([7d421d3](https://github.com/peaceiris/actions-gh-pages/commit/7d421d3e4c784eaebafdf020ccf4ce29ac14569a))
+* update ([95d87cf](https://github.com/peaceiris/actions-gh-pages/commit/95d87cfaa53b3d799c1c931048a43a92ddb87d15))
+
+
+
+## [3.5.7](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.6...v3.5.7) (2020-04-15)
+
+
+### chore
+
+* Add minify option to ncc ([7c46059](https://github.com/peaceiris/actions-gh-pages/commit/7c4605913c8e25e5bcb647c41df24622df973dea))
+* bump node and npm (#232) ([8dd38be](https://github.com/peaceiris/actions-gh-pages/commit/8dd38bec4d0fe06da1c552846e91f1c9482eaa81)), closes [#232](https://github.com/peaceiris/actions-gh-pages/issues/232)
+* Print context for debug (#160) ([3f58382](https://github.com/peaceiris/actions-gh-pages/commit/3f58382eeacaa13844a32b1499dd97073c0c134e)), closes [#160](https://github.com/peaceiris/actions-gh-pages/issues/160)
+
+### ci
+
+* Add automerged_updates ([6d889ad](https://github.com/peaceiris/actions-gh-pages/commit/6d889ad7e96ddde23d10af55c91bc853e7ae6875))
+* Add cname ([3789ef4](https://github.com/peaceiris/actions-gh-pages/commit/3789ef4a0afefde589ddc2627f1e15c9b781bf8e))
+* Add dev-image workflow (#177) ([465b328](https://github.com/peaceiris/actions-gh-pages/commit/465b328f7559c99f1baf1b953e51031e9e95cb3c)), closes [#177](https://github.com/peaceiris/actions-gh-pages/issues/177)
+* Add GitHub context dump step [skip ci] ([6cf4da4](https://github.com/peaceiris/actions-gh-pages/commit/6cf4da4de2c6a448403c94c765853e21ec9c59d9))
+* bump mdbook from 0.3.5 to 0.3.6 ([0a1633a](https://github.com/peaceiris/actions-gh-pages/commit/0a1633ac3140c8be2e2eded5961aa2a17831328e))
+* comment out pull_request event ([cf8d655](https://github.com/peaceiris/actions-gh-pages/commit/cf8d65531019ee6fb9bae2ce615c7c7735073cac))
+* delete stale workflow ([98e0f60](https://github.com/peaceiris/actions-gh-pages/commit/98e0f6025c650cd5e0bafe454a78754e170fd08d))
+* Merge test workflows (#204) ([ed5a99d](https://github.com/peaceiris/actions-gh-pages/commit/ed5a99d6377a295a05189f1dac5bc9e32739fced)), closes [#204](https://github.com/peaceiris/actions-gh-pages/issues/204)
+* set update_schedule live ([2a787f0](https://github.com/peaceiris/actions-gh-pages/commit/2a787f018275ed6400c555b0144e8f15b9c3db4f))
+
+### deps
+
+* bump @types/jest from 25.1.4 to 25.1.5 (#208) ([78d67e4](https://github.com/peaceiris/actions-gh-pages/commit/78d67e4cbe7435ac1848ba5f4e5be1598dd0f843)), closes [#208](https://github.com/peaceiris/actions-gh-pages/issues/208)
+* bump @types/jest from 25.1.5 to 25.2.1 (#213) ([37ce049](https://github.com/peaceiris/actions-gh-pages/commit/37ce049d087d29dae2d276e0df6665258c979d66)), closes [#213](https://github.com/peaceiris/actions-gh-pages/issues/213)
+* bump @types/js-yaml from 3.12.2 to 3.12.3 (#175) ([36c6bd4](https://github.com/peaceiris/actions-gh-pages/commit/36c6bd42bd9f29c9b6b8e157bd9e41da701fb77e)), closes [#175](https://github.com/peaceiris/actions-gh-pages/issues/175)
+* bump @types/node from 12.12.30 to 12.12.31 (#176) ([618acc1](https://github.com/peaceiris/actions-gh-pages/commit/618acc18f38ea8866cb92509e5a1fb33e5b475cb)), closes [#176](https://github.com/peaceiris/actions-gh-pages/issues/176)
+* bump @types/node from 12.12.31 to 12.12.32 (#187) ([e31acce](https://github.com/peaceiris/actions-gh-pages/commit/e31acce9d332395ce09ec79567979ad6afc2083a)), closes [#187](https://github.com/peaceiris/actions-gh-pages/issues/187)
+* bump @types/node from 12.12.32 to 12.12.34 (#203) ([45a2a58](https://github.com/peaceiris/actions-gh-pages/commit/45a2a58fb026bdd007fc960472e4c64cac3d1742)), closes [#203](https://github.com/peaceiris/actions-gh-pages/issues/203)
+* bump @types/node from 12.12.34 to 12.12.35 (#222) ([8af9b8c](https://github.com/peaceiris/actions-gh-pages/commit/8af9b8c0d5a79ac59deca7c805b3dbb2f27b6637)), closes [#222](https://github.com/peaceiris/actions-gh-pages/issues/222)
+* bump @typescript-eslint/eslint-plugin from 2.23.0 to 2.24.0 (#162) ([62dcd84](https://github.com/peaceiris/actions-gh-pages/commit/62dcd84517adc033e68d52d0a32e2d5edaa1a3c3)), closes [#162](https://github.com/peaceiris/actions-gh-pages/issues/162)
+* bump @typescript-eslint/eslint-plugin from 2.24.0 to 2.25.0 (#171) ([ecd8e7b](https://github.com/peaceiris/actions-gh-pages/commit/ecd8e7bc48e57d3ea82184116fa1710c425d57a6)), closes [#171](https://github.com/peaceiris/actions-gh-pages/issues/171)
+* bump @typescript-eslint/eslint-plugin from 2.25.0 to 2.26.0 (#201) ([ca2c254](https://github.com/peaceiris/actions-gh-pages/commit/ca2c2541577d3e41f6c7c2265430a219b974c314)), closes [#201](https://github.com/peaceiris/actions-gh-pages/issues/201)
+* bump @typescript-eslint/eslint-plugin from 2.26.0 to 2.27.0 (#219) ([046c703](https://github.com/peaceiris/actions-gh-pages/commit/046c703d6daeac7f9c32fbd0adf9f1412b025361)), closes [#219](https://github.com/peaceiris/actions-gh-pages/issues/219)
+* bump @typescript-eslint/eslint-plugin from 2.27.0 to 2.28.0 (#231) ([ddf2c5b](https://github.com/peaceiris/actions-gh-pages/commit/ddf2c5b9f16b38116d8f194ed9804fe079d950ca)), closes [#231](https://github.com/peaceiris/actions-gh-pages/issues/231)
+* bump @typescript-eslint/parser from 2.23.0 to 2.24.0 (#161) ([7c5e9be](https://github.com/peaceiris/actions-gh-pages/commit/7c5e9bef11bc4c1a57fd1f7794c93518f320293d)), closes [#161](https://github.com/peaceiris/actions-gh-pages/issues/161)
+* bump @typescript-eslint/parser from 2.24.0 to 2.25.0 (#170) ([04cd6de](https://github.com/peaceiris/actions-gh-pages/commit/04cd6de8fd7f30f0c3c725e3981a6f8e549f19fa)), closes [#170](https://github.com/peaceiris/actions-gh-pages/issues/170)
+* bump @typescript-eslint/parser from 2.25.0 to 2.26.0 (#200) ([042b824](https://github.com/peaceiris/actions-gh-pages/commit/042b824d8bb5cde606db907ffc0edd525b9557f1)), closes [#200](https://github.com/peaceiris/actions-gh-pages/issues/200)
+* bump @typescript-eslint/parser from 2.26.0 to 2.27.0 (#218) ([da14e08](https://github.com/peaceiris/actions-gh-pages/commit/da14e086461d30a80a0c62fb0ee531635c021a92)), closes [#218](https://github.com/peaceiris/actions-gh-pages/issues/218)
+* bump @typescript-eslint/parser from 2.27.0 to 2.28.0 (#230) ([d8356e3](https://github.com/peaceiris/actions-gh-pages/commit/d8356e3cf1b99104b423cfeb405751ce358b46f1)), closes [#230](https://github.com/peaceiris/actions-gh-pages/issues/230)
+* bump @zeit/ncc from 0.21.1 to 0.22.0 (#172) ([1a3f0fd](https://github.com/peaceiris/actions-gh-pages/commit/1a3f0fd0f6ec1a0544e7489db322e559823f3538)), closes [#172](https://github.com/peaceiris/actions-gh-pages/issues/172)
+* bump @zeit/ncc from 0.22.0 to 0.22.1 (#215) ([711b0ed](https://github.com/peaceiris/actions-gh-pages/commit/711b0ed1cd911cef0808ec5fe090f240fb3e804e)), closes [#215](https://github.com/peaceiris/actions-gh-pages/issues/215)
+* bump git from 2.25.1 to 2.26.0 (#182) ([3183d34](https://github.com/peaceiris/actions-gh-pages/commit/3183d3481b7ef83750e6365ea9f28258df85c5f7)), closes [#182](https://github.com/peaceiris/actions-gh-pages/issues/182)
+* bump git from 2.26.0 to 2.26.1 (#233) ([df5698c](https://github.com/peaceiris/actions-gh-pages/commit/df5698c4aaaf8edee82ce0d2799caddde3d2f6bc)), closes [#233](https://github.com/peaceiris/actions-gh-pages/issues/233)
+* bump husky from 4.2.3 to 4.2.4 (#225) ([abd7ea5](https://github.com/peaceiris/actions-gh-pages/commit/abd7ea550b2efa7ba4353ed178a5cceab5741b4e)), closes [#225](https://github.com/peaceiris/actions-gh-pages/issues/225)
+* bump husky from 4.2.4 to 4.2.5 (#226) ([bf8dc2c](https://github.com/peaceiris/actions-gh-pages/commit/bf8dc2ce19690fde3f8f875f0b56726a8467f043)), closes [#226](https://github.com/peaceiris/actions-gh-pages/issues/226)
+* bump jest from 25.1.0 to 25.2.0 (#179) ([75680da](https://github.com/peaceiris/actions-gh-pages/commit/75680dae34ad8b6811ee6482a809d0be3f24c743)), closes [#179](https://github.com/peaceiris/actions-gh-pages/issues/179)
+* bump jest from 25.2.0 to 25.2.1 (#180) ([9f0d4d4](https://github.com/peaceiris/actions-gh-pages/commit/9f0d4d44b9782b3baa0c97b515061b16a78a4ccd)), closes [#180](https://github.com/peaceiris/actions-gh-pages/issues/180)
+* bump jest from 25.2.1 to 25.2.2 (#184) ([85823c6](https://github.com/peaceiris/actions-gh-pages/commit/85823c67e1a6ee02bca13ad66bdedcaf932f7fb8)), closes [#184](https://github.com/peaceiris/actions-gh-pages/issues/184)
+* bump jest from 25.2.2 to 25.2.3 (#186) ([25deb78](https://github.com/peaceiris/actions-gh-pages/commit/25deb782d00a799f89ae56a01471de34eb584507)), closes [#186](https://github.com/peaceiris/actions-gh-pages/issues/186)
+* bump jest from 25.2.3 to 25.2.4 (#197) ([339315a](https://github.com/peaceiris/actions-gh-pages/commit/339315a4b0911f7ba5f46b48517303a51ab3c9de)), closes [#197](https://github.com/peaceiris/actions-gh-pages/issues/197)
+* bump jest from 25.2.4 to 25.2.6 (#207) ([af6a597](https://github.com/peaceiris/actions-gh-pages/commit/af6a5970d8665fe405d2d41739a205fb02c3c82b)), closes [#207](https://github.com/peaceiris/actions-gh-pages/issues/207)
+* bump jest from 25.2.6 to 25.2.7 (#210) ([7f9aba2](https://github.com/peaceiris/actions-gh-pages/commit/7f9aba2ea85c816a7bc7d764386db0d22fb27664)), closes [#210](https://github.com/peaceiris/actions-gh-pages/issues/210)
+* bump jest from 25.2.7 to 25.3.0 (#221) ([a07d711](https://github.com/peaceiris/actions-gh-pages/commit/a07d7115c5ba0974e1cc521c12f921344a5cb740)), closes [#221](https://github.com/peaceiris/actions-gh-pages/issues/221)
+* bump jest-circus from 25.1.0 to 25.2.0 (#178) ([669db9c](https://github.com/peaceiris/actions-gh-pages/commit/669db9c5d1ea78f2fe5e844401803de4ebd79516)), closes [#178](https://github.com/peaceiris/actions-gh-pages/issues/178)
+* bump jest-circus from 25.2.0 to 25.2.1 (#181) ([2be10a7](https://github.com/peaceiris/actions-gh-pages/commit/2be10a799985a223581c2368b866882d2a13515c)), closes [#181](https://github.com/peaceiris/actions-gh-pages/issues/181)
+* bump jest-circus from 25.2.1 to 25.2.2 (#183) ([1b90454](https://github.com/peaceiris/actions-gh-pages/commit/1b904544aa6f23628ab65efd7399f9b22406bddf)), closes [#183](https://github.com/peaceiris/actions-gh-pages/issues/183)
+* bump jest-circus from 25.2.2 to 25.2.3 (#185) ([0e2b180](https://github.com/peaceiris/actions-gh-pages/commit/0e2b180da6b0035c64940c6fcbcdfd16fc02ab1f)), closes [#185](https://github.com/peaceiris/actions-gh-pages/issues/185)
+* bump jest-circus from 25.2.3 to 25.2.4 (#196) ([f5eb08f](https://github.com/peaceiris/actions-gh-pages/commit/f5eb08fafcb4f22c6636badd1d35676cfec90f57)), closes [#196](https://github.com/peaceiris/actions-gh-pages/issues/196)
+* bump jest-circus from 25.2.4 to 25.2.6 (#206) ([7c0ae72](https://github.com/peaceiris/actions-gh-pages/commit/7c0ae727e6ff477fc420bd0fc74f6c706b433508)), closes [#206](https://github.com/peaceiris/actions-gh-pages/issues/206)
+* bump jest-circus from 25.2.6 to 25.2.7 (#209) ([c742786](https://github.com/peaceiris/actions-gh-pages/commit/c742786fc9fe33aa256482960f82f3e9e3e7e591)), closes [#209](https://github.com/peaceiris/actions-gh-pages/issues/209)
+* bump jest-circus from 25.2.7 to 25.3.0 (#220) ([20e19cf](https://github.com/peaceiris/actions-gh-pages/commit/20e19cf1eb238cb2bdeb1ce8c4a586586433b1ab)), closes [#220](https://github.com/peaceiris/actions-gh-pages/issues/220)
+* bump lint-staged from 10.0.10 to 10.1.0 (#199) ([3ed76c9](https://github.com/peaceiris/actions-gh-pages/commit/3ed76c92c68fe6ce8abdec7c18ce08cd4fc73f5d)), closes [#199](https://github.com/peaceiris/actions-gh-pages/issues/199)
+* bump lint-staged from 10.0.8 to 10.0.9 (#174) ([bb022f3](https://github.com/peaceiris/actions-gh-pages/commit/bb022f3294a46c3cb76aabad2a3c6256f4d94f4a)), closes [#174](https://github.com/peaceiris/actions-gh-pages/issues/174)
+* bump lint-staged from 10.0.9 to 10.0.10 (#195) ([9dddc33](https://github.com/peaceiris/actions-gh-pages/commit/9dddc3350fb83f9b17f09d2ae0df8cfe821d3091)), closes [#195](https://github.com/peaceiris/actions-gh-pages/issues/195)
+* bump lint-staged from 10.1.0 to 10.1.1 (#205) ([42a3ae6](https://github.com/peaceiris/actions-gh-pages/commit/42a3ae6a382b047d97c25c18d069c9403b957d2f)), closes [#205](https://github.com/peaceiris/actions-gh-pages/issues/205)
+* bump lint-staged from 10.1.1 to 10.1.2 (#214) ([e5063fa](https://github.com/peaceiris/actions-gh-pages/commit/e5063fa6dd73e5a0d63f79a29ce874029949af00)), closes [#214](https://github.com/peaceiris/actions-gh-pages/issues/214)
+* bump lint-staged from 10.1.2 to 10.1.3 (#224) ([ab7b255](https://github.com/peaceiris/actions-gh-pages/commit/ab7b25543231b886faf8f1cf63fd5085eeedf796)), closes [#224](https://github.com/peaceiris/actions-gh-pages/issues/224)
+* bump node 12.16.1 to 12.16.2 (#223) ([6fcf128](https://github.com/peaceiris/actions-gh-pages/commit/6fcf128c187d621040cda918d737c816339b2268)), closes [#223](https://github.com/peaceiris/actions-gh-pages/issues/223)
+* bump prettier from 1.19.1 to 2.0.1 (#167) ([148a657](https://github.com/peaceiris/actions-gh-pages/commit/148a6573c6b840a7235933a411b6807f0914adc0)), closes [#167](https://github.com/peaceiris/actions-gh-pages/issues/167)
+* bump prettier from 2.0.1 to 2.0.2 (#173) ([4933c8e](https://github.com/peaceiris/actions-gh-pages/commit/4933c8ef88a7aba30905620f3b3cd2b2c516dd19)), closes [#173](https://github.com/peaceiris/actions-gh-pages/issues/173)
+* bump prettier from 2.0.2 to 2.0.4 (#217) ([ab37125](https://github.com/peaceiris/actions-gh-pages/commit/ab371259dd262501f100a0b6fdbe4231200e8938)), closes [#217](https://github.com/peaceiris/actions-gh-pages/issues/217)
+* bump ts-jest from 25.2.1 to 25.3.0 (#198) ([e26a05e](https://github.com/peaceiris/actions-gh-pages/commit/e26a05e4739a55410254da8777766f46eab5826a)), closes [#198](https://github.com/peaceiris/actions-gh-pages/issues/198)
+* bump ts-jest from 25.3.0 to 25.3.1 (#211) ([d48d5de](https://github.com/peaceiris/actions-gh-pages/commit/d48d5de82e47f8e4fd718b2ec979301a99cb7202)), closes [#211](https://github.com/peaceiris/actions-gh-pages/issues/211)
+* npm audit fix ([58be994](https://github.com/peaceiris/actions-gh-pages/commit/58be9948094654ed7853e644e1fe29310c1325f2))
+
+### docs
+
+* Add branches ([596c2d5](https://github.com/peaceiris/actions-gh-pages/commit/596c2d55482b737210a851c25ba572f61685c85e))
+* Add fetch-depth 0 ([32a0227](https://github.com/peaceiris/actions-gh-pages/commit/32a0227f7c6301faaa80bd5680eb93e5e049996f))
+* Add github_token section ([d59e15b](https://github.com/peaceiris/actions-gh-pages/commit/d59e15bbd09dea2d67fca9947f5526fe0e718b63))
+* Add github/personal-website ([e2a54ec](https://github.com/peaceiris/actions-gh-pages/commit/e2a54ec0b920afe6f8108d1b0237cd7963faafc2))
+* Add link to example ([c50f9fd](https://github.com/peaceiris/actions-gh-pages/commit/c50f9fd17d0d1d6d24b4c45c4e6e09ea9187536f))
+* Add link to interview (#194) ([c276f65](https://github.com/peaceiris/actions-gh-pages/commit/c276f65cf9ffa972e8f2cd4c358120bebb357c3f)), closes [#194](https://github.com/peaceiris/actions-gh-pages/issues/194)
+* Add path to workflow file ([1ee7d6e](https://github.com/peaceiris/actions-gh-pages/commit/1ee7d6e98a5634528769f1e28d7982706cf0356c))
+* Add Swift Publish example (#228) ([9f90987](https://github.com/peaceiris/actions-gh-pages/commit/9f90987bad7ac98d4f0c2dbad6b95ca3d2471102)), closes [#228](https://github.com/peaceiris/actions-gh-pages/issues/228) [#227](https://github.com/peaceiris/actions-gh-pages/issues/227)
+* bump actions/checkout to v2 in Hugo example ([0294e8c](https://github.com/peaceiris/actions-gh-pages/commit/0294e8c526ec496925ffbef19885cc57d2ab0383))
+* bump hugo and mdbook ([b6bc504](https://github.com/peaceiris/actions-gh-pages/commit/b6bc5040aafba38af3782d27801d58f2a06ddd6f))
+* bump mdbook from 0.3.5 to 0.3.6 ([164addf](https://github.com/peaceiris/actions-gh-pages/commit/164addf07d7d653dd193300a4828d00437c56b65))
+* bump node from 10 to 12 (#192) ([9597ab9](https://github.com/peaceiris/actions-gh-pages/commit/9597ab97de490652c80824ee63060736af58c369)), closes [#192](https://github.com/peaceiris/actions-gh-pages/issues/192)
+* fix typo ([3e53047](https://github.com/peaceiris/actions-gh-pages/commit/3e53047dc0f67282685d350dd6a0e3342c70d20f))
+* Improve Docusaurus example (#191) ([0144209](https://github.com/peaceiris/actions-gh-pages/commit/014420965cfc3721de582be7a7c01ec36b5b1d21)), closes [#191](https://github.com/peaceiris/actions-gh-pages/issues/191)
+* Improve Elm example (#190) ([8739981](https://github.com/peaceiris/actions-gh-pages/commit/87399813a5eb5ec3a73d11719066dceff2620582)), closes [#190](https://github.com/peaceiris/actions-gh-pages/issues/190)
+* Improve Flutter example (#189) ([2ea85f7](https://github.com/peaceiris/actions-gh-pages/commit/2ea85f732266fec9726a6b32856b338dfe36f056)), closes [#189](https://github.com/peaceiris/actions-gh-pages/issues/189)
+* Improve section name of enable_jekyll (#193) ([fbff0cd](https://github.com/peaceiris/actions-gh-pages/commit/fbff0cd1e0680c9ff1a9ffd34306fb2199308eac)), closes [#193](https://github.com/peaceiris/actions-gh-pages/issues/193)
+* update ([9614091](https://github.com/peaceiris/actions-gh-pages/commit/9614091a5e44b16c3add28e53671146a91dbfbe4))
+* Update Docusaurus workflow example (#229) ([fb15409](https://github.com/peaceiris/actions-gh-pages/commit/fb15409be9a17556fc8c4b2335735466e8b8347b)), closes [#229](https://github.com/peaceiris/actions-gh-pages/issues/229)
+* update test badge ([a93c85c](https://github.com/peaceiris/actions-gh-pages/commit/a93c85ca96782d06b7c1f68e0d1bd7d337cf40cb))
+
+### feat
+
+* Set outputs.skip when action skipped ([8019d94](https://github.com/peaceiris/actions-gh-pages/commit/8019d941f376d6f650735a88216bf5baebb7f397)), closes [#165](https://github.com/peaceiris/actions-gh-pages/issues/165)
+
+
+
+## [3.5.6](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.5...v3.5.6) (2020-03-16)
+
+
+### fix
+
+* skip on fork (#159) ([6fa13fe](https://github.com/peaceiris/actions-gh-pages/commit/6fa13fefb393227eec5c9710d92e8bffa917546a)), closes [#159](https://github.com/peaceiris/actions-gh-pages/issues/159)
+
+
+
+## [3.5.5](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4...v3.5.5) (2020-03-16)
+
+
+### chore
+
+* Add new task all ([01fdaf2](https://github.com/peaceiris/actions-gh-pages/commit/01fdaf2f0274401d2403c809b20c37fb7a8535a6))
+
+### fix
+
+* skip on fork if pull_request (#158) ([d6bd618](https://github.com/peaceiris/actions-gh-pages/commit/d6bd6182f264ce695613180743d42e377570bbf4)), closes [#158](https://github.com/peaceiris/actions-gh-pages/issues/158) [#157](https://github.com/peaceiris/actions-gh-pages/issues/157)
+
+
+
+## [3.5.4](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.3...v3.5.4) (2020-03-16)
+
+
+### fix
+
+* skip deployment on forks (#156) ([4f06df8](https://github.com/peaceiris/actions-gh-pages/commit/4f06df820b7a5882e2faef0e6929bb670140fba0)), closes [#156](https://github.com/peaceiris/actions-gh-pages/issues/156) [#153](https://github.com/peaceiris/actions-gh-pages/issues/153)
+
+
+
+## [3.5.4-6](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4-5...v3.5.4-6) (2020-03-15)
+
+
+### fix
+
+* skip logic ([44bdada](https://github.com/peaceiris/actions-gh-pages/commit/44bdada02c71f646d23ffefe1ea07d16386dbf83))
+
+
+
+## [3.5.4-5](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4-4...v3.5.4-5) (2020-03-14)
+
+
+### fix
+
+* property access ([72f58a0](https://github.com/peaceiris/actions-gh-pages/commit/72f58a06cf5db88d3eb982f57de8dbc266e39232))
+
+
+
+## [3.5.4-4](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4-3...v3.5.4-4) (2020-03-14)
+
+
+### test
+
+* skipOnFork() ([6f9a5b7](https://github.com/peaceiris/actions-gh-pages/commit/6f9a5b7a66bbf855cadc34099fa6450c40eff4a2))
+
+
+
+## [3.5.4-3](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4-2...v3.5.4-3) (2020-03-14)
+
+
+### fix
+
+* skip logic ([01976c9](https://github.com/peaceiris/actions-gh-pages/commit/01976c9d9b95b42997caa2a85c2d737eb75e852e))
+
+
+
+## [3.5.4-2](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4-1...v3.5.4-2) (2020-03-14)
+
+
+### fix
+
+* skip logic ([c97a39a](https://github.com/peaceiris/actions-gh-pages/commit/c97a39a35f681badbf7490c2786eddf06b17316d))
+
+
+
+## [3.5.4-1](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.4-0...v3.5.4-1) (2020-03-14)
+
+
+### fix
+
+* isForkRepository ([6546aa9](https://github.com/peaceiris/actions-gh-pages/commit/6546aa96085e89bd91adc56f58be665766e93a1e))
+
+
+
+## [3.5.4-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.3...v3.5.4-0) (2020-03-14)
+
+
+### fix
+
+* skip on forks ([c320668](https://github.com/peaceiris/actions-gh-pages/commit/c320668126b104ad2c15ea1b583a75cd3978c2f3)), closes [#153](https://github.com/peaceiris/actions-gh-pages/issues/153)
+
+
+
+## [3.5.3](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.2...v3.5.3) (2020-03-13)
+
+
+### deps
+
+* [security] bump acorn from 6.4.0 to 6.4.1 (#155) ([2fa0a59](https://github.com/peaceiris/actions-gh-pages/commit/2fa0a59e21f19c0862ebc505187b3ede95a92561)), closes [#155](https://github.com/peaceiris/actions-gh-pages/issues/155)
+* bump @types/node from 12.12.29 to 12.12.30 (#154) ([d1f9877](https://github.com/peaceiris/actions-gh-pages/commit/d1f987783c05614c72b8c5009fbfd941982128ec)), closes [#154](https://github.com/peaceiris/actions-gh-pages/issues/154)
+
+
+
+## [3.5.2](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.1...v3.5.2) (2020-03-12)
+
+
+### chore
+
+* reindent ([b2788ae](https://github.com/peaceiris/actions-gh-pages/commit/b2788ae3c6c463fccde4f9db8abac12cf2f42b72))
+
+### deps
+
+* bump @typescript-eslint/eslint-plugin from 2.22.0 to 2.23.0 (#150) ([7f32718](https://github.com/peaceiris/actions-gh-pages/commit/7f32718f667956be6bab3cd2dffe9559cdd26fc7)), closes [#150](https://github.com/peaceiris/actions-gh-pages/issues/150)
+* bump @typescript-eslint/parser from 2.22.0 to 2.23.0 (#149) ([6801987](https://github.com/peaceiris/actions-gh-pages/commit/680198766bcc7c4625ee5c9f599187f99bf0c118)), closes [#149](https://github.com/peaceiris/actions-gh-pages/issues/149)
+
+### fix
+
+* set commit author as local config (#152) ([a1ff787](https://github.com/peaceiris/actions-gh-pages/commit/a1ff787715905a17a17d1ab7b42eba976a4553c6)), closes [#152](https://github.com/peaceiris/actions-gh-pages/issues/152) [#151](https://github.com/peaceiris/actions-gh-pages/issues/151)
+
+
+
+## [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)
 
 

Dockerfile

@@ -16,7 +16,7 @@ RUN apt-get update && \
     npm i -g npm
 
 WORKDIR /git
-ENV GIT_VERSION="2.25.1"
+ENV GIT_VERSION="2.26.2"
 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" && \

Makefile

@@ -4,6 +4,7 @@ IMAGE_NAME := actions_github_pages_dev:latest
 NODE_VERSION := $(shell cat ./.nvmrc)
 DOCKER_BUILD := docker build . -t $(IMAGE_NAME) --build-arg NODE_VERSION=$(NODE_VERSION)
 DOCKER_RUN := docker run --rm -i -t -v ${PWD}:/repo -v ~/.gitconfig:/root/.gitconfig $(IMAGE_NAME)
+DOCKER_RUN_CI := docker run --rm -v ${PWD}:/repo $(IMAGE_NAME)
 
 
 .PHONY: build
@@ -14,6 +15,10 @@ build:
 run:
 	$(DOCKER_RUN) $(cmd)
 
+.PHONY: cirun
+cirun:
+	$(DOCKER_RUN_CI) $(cmd)
+
 .PHONY: test
 test:
 	$(DOCKER_RUN) npm test
@@ -21,3 +26,11 @@ test:
 .PHONY: commit
 commit:
 	$(DOCKER_RUN) git commit -m "$(msg)"
+
+.PHONY: all
+all:
+	$(DOCKER_RUN) npm run all
+
+.PHONY: ciall
+ciall:
+	$(DOCKER_RUN_CI) npm run all

README.md

@@ -1,23 +1,22 @@
 [![license](https://img.shields.io/github/license/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/blob/master/LICENSE)
 [![release](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases/latest)
 [![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases)
-![Test Action](https://github.com/peaceiris/actions-gh-pages/workflows/Test%20Action/badge.svg?branch=master&event=push)
+![Test](https://github.com/peaceiris/actions-gh-pages/workflows/Test/badge.svg?branch=master&event=push)
 [![CodeFactor](https://www.codefactor.io/repository/github/peaceiris/actions-gh-pages/badge)](https://www.codefactor.io/repository/github/peaceiris/actions-gh-pages)
 [![Release Feed](https://img.shields.io/badge/release-feed-yellow)](https://github.com/peaceiris/actions-gh-pages/releases.atom)
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=peaceiris/actions-gh-pages)](https://dependabot.com)
 
 <img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="./images/ogp.svg">
 
-> This Action has been migrated to a TypeScript Action (version 3).
->
-> The old Docker Action is [peaceiris/actions-gh-pages@v2](https://github.com/peaceiris/actions-gh-pages/tree/v2)
+This Action has been migrated to a TypeScript Action (version 3).
+The old Docker Action is [peaceiris/actions-gh-pages@v2](https://github.com/peaceiris/actions-gh-pages/tree/v2)
 
 
 
 ## GitHub Actions for GitHub Pages
 
 This is a **GitHub Action** to deploy your static files to **GitHub Pages**.
-This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, mdBook, etc.)
+This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, mdBook, and so on.)
 
 [Static Site Generators]: https://www.staticgen.com/
 
@@ -42,11 +41,16 @@ Three tokens are supported.
 | `deploy_key` | ✅️ | ✅️ | SSH | Necessary |
 | `personal_token` | ✅️ | ✅️ | HTTPS | Necessary |
 
+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
 
+All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
+
 | runs-on | `github_token` | `deploy_key` | `personal_token` |
 |---|:---:|:---:|:---:|
 | ubuntu-18.04 | ✅️ | ✅️ | ✅️ |
+| ubuntu-16.04 | ✅️ | ✅️ | ✅️ |
 | macos-latest | ✅️ | ✅️ | ✅️ |
 | windows-latest | ✅️ | (2) | ✅️ |
 
@@ -64,10 +68,13 @@ Three tokens are supported.
   - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
   - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
 - [Options](#options)
+  - [⭐️ `github_token`](#%EF%B8%8F-github_token)
   - [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
   - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
+  - [⭐️ `publish_branch`](#%EF%B8%8F-publish_branch)
+  - [⭐️ `publish_dir`](#%EF%B8%8F-publish_dir)
   - [⭐️ CNAME](#%EF%B8%8F-cname)
-  - [⭐️ Enable Jekyll](#%EF%B8%8F-enable-jekyll)
+  - [⭐️ Enable Built-in Jekyll](#%EF%B8%8F-enable-built-in-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)
@@ -77,6 +84,7 @@ Three tokens are supported.
   - [⭐️ 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)
 - [Examples](#examples)
   - [⭐️ Static Site Generators with Node.js](#%EF%B8%8F-static-site-generators-with-nodejs)
@@ -88,6 +96,8 @@ Three tokens are supported.
   - [⭐️ mdBook (Rust)](#%EF%B8%8F-mdbook-rust)
   - [⭐️ Flutter Web](#%EF%B8%8F-flutter-web)
   - [⭐️ Elm](#%EF%B8%8F-elm)
+  - [⭐️ github/personal-website](#%EF%B8%8F-githubpersonal-website)
+  - [⭐️ Swift Publish](#%EF%B8%8F-swift-publish)
 - [License](#license)
 - [Maintainer](#maintainer)
 
@@ -119,14 +129,15 @@ jobs:
   deploy:
     runs-on: ubuntu-18.04
     steps:
-      - uses: actions/checkout@v1
-        # with:
-        #   submodules: true
+      - uses: actions/checkout@v2
+        with:
+          submodules: true  # Fetch Hugo themes
+          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
 
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.64.0'
+          hugo-version: '0.68.3'
 
       - name: Build
         run: hugo --minify
@@ -140,13 +151,9 @@ jobs:
 
 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) |
-
-| Deploy step log | GitHub Pages log |
-|---|---|
-| ![](./images/log3.jpg) | ![](./images/log4.jpg) |
+| ![](./images/log_overview.jpg) | ![](./images/log_success.jpg) |
 
 ### ⭐️ Repository type - User and Organization
 
@@ -191,9 +198,25 @@ jobs:
 
 ## Options
 
+### ⭐️ `github_token`
+
+**This option is for `GITHUB_TOKEN`, not a personal access token.**
+
+GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in your workflow. You can use the `GITHUB_TOKEN` to authenticate in a workflow run.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_dir: ./public
+```
+
+For more details about `GITHUB_TOKEN`: [Authenticating with the GITHUB_TOKEN - GitHub Help](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
+
 ### ⭐️ `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.
+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
@@ -216,6 +239,30 @@ Read [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create yo
     publish_dir: ./public
 ```
 
+### ⭐️ `publish_branch`
+
+A target branch to deploy to GitHub Pages. The default is `gh-pages`.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_branch: master  # default: gh-pages
+```
+
+### ⭐️ `publish_dir`
+
+A target directory to deploy to GitHub Pages. The default is `public`.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_dir: ./out  # default: public
+```
+
 ### ⭐️ CNAME
 
 To add `CNAME` file, we can set the `cname` option.
@@ -231,9 +278,11 @@ For more details about `CNAME`, read the official documentation: [Managing a cus
     cname: github.com
 ```
 
-### ⭐️ Enable Jekyll
+### ⭐️ Enable Built-in Jekyll
 
-If you want GitHub Pages to process the site with the static site generator Jekyll, set `enable_jekyll` to true.
+If you want GitHub Pages to process your site with the static site generator Jekyll, set `enable_jekyll` to true.
+
+[github/personal-website](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-githubpersonal-website) is one of the examples using GitHub Pages built-in Jekyll.
 
 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.
 
@@ -328,13 +377,15 @@ A commit is always created with the same user.
   with:
     github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./public
-    user_name: iris
-    user_email: iris@peaceiris.com
+    user_name: 'github-actions[bot]'
+    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.
+Set a custom commit message.
 When we create a commit with a message `docs: Update some post`, a deployment commit will be generated with a message `docs: Update some post ${GITHUB_SHA}`.
 
 ```yaml
@@ -346,6 +397,20 @@ When we create a commit with a message `docs: Update some post`, a deployment co
     commit_message: ${{ github.event.head_commit.message }}
 ```
 
+![Set a custom commit message - GitHub Actions for GitHub Pages](./images/commit_message.jpg)
+
+To set a full custom commit message without a triggered commit hash,
+use the `full_commit_message` option instead of the `commit_message` option.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_dir: ./public
+    full_commit_message: ${{ github.event.head_commit.message }}
+```
+
 ### ⭐️ Create Git tag
 
 Here is an example workflow.
@@ -431,6 +496,18 @@ Next, Go to **Repository Settings**
 |---|---|
 | ![](./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. After that, do the second deployment like the following pictures.
+
+| 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.
@@ -448,7 +525,7 @@ It is useful to watch this repository (release only) to check the [latest releas
 
 ### ⭐️ Static Site Generators with Node.js
 
-[hexo], [gitbook], [vuepress], [react-static], [gridsome], etc.
+[hexo], [gitbook], [vuepress], [react-static], [gridsome], and so on.
 
 [hexo]: https://github.com/hexojs/hexo
 [gitbook]: https://github.com/GitbookIO/gitbook
@@ -475,7 +552,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '12.x'
 
       - name: Cache dependencies
         uses: actions/cache@v1
@@ -519,7 +596,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '12.x'
 
       - name: Cache dependencies
         uses: actions/cache@v1
@@ -567,7 +644,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '12.x'
 
       - name: Get yarn cache
         id: yarn-cache
@@ -618,7 +695,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '12.x'
 
       - name: Cache dependencies
         uses: actions/cache@v1
@@ -641,14 +718,13 @@ jobs:
 
 ### ⭐️ Docusaurus
 
-An example for pages created using [Docusaurus](https://docusaurus.io/).
+An example workflow for [Docusaurus](https://docusaurus.io/).
 
-Examples where this is being used:
-
-- [Mittens](https://github.com/ExpediaGroup/mittens)
-- [graphql-kotlin](https://github.com/ExpediaGroup/graphql-kotlin)
+`npx @docusaurus/init@next init website classic` is useful to create a new Docusaurus project.
 
 ```yaml
+# .github/workflows/deploy.yml
+
 name: github pages
 
 on:
@@ -656,45 +732,48 @@ on:
     branches:
       - master
     paths:
-      - 'docs/**'
+      - '.github/workflows/deploy.yml'
       - 'website/**'
 
 jobs:
   deploy:
     runs-on: ubuntu-18.04
+    defaults:
+      run:
+        working-directory: website
     steps:
       - uses: actions/checkout@v2
 
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: '12.x'
+
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
 
       - name: Cache dependencies
         uses: actions/cache@v1
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('website/package-lock.json') }}
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-website-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            ${{ runner.os }}-node-
+            ${{ runner.os }}-website-
 
-      - name: Build
-        run: |
-          cd website
-          npm ci
-          npm run build
+      - run: yarn install
+      - run: yarn 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>
+          publish_dir: ./website/build
 ```
 
 ### ⭐️ Static Site Generators with Python
 
-[pelican], [MkDocs], [sphinx], etc.
+[pelican], [MkDocs], [sphinx], and so on.
 
 [pelican]: https://github.com/getpelican/pelican
 [MkDocs]: https://github.com/mkdocs/mkdocs
@@ -717,23 +796,29 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
-          python-version: '3.6'
-          architecture: 'x64'
+          python-version: '3.8'
+
+      - name: Upgrade pip
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "::set-output name=dir::$(pip cache dir)"
 
       - name: Cache dependencies
         uses: actions/cache@v1
         with:
-          path: ~/.cache/pip
+          path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
       - name: Install dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r ./requirements.txt
+        run: python3 -m pip install -r ./requirements.txt
 
       - run: mkdocs build
 
@@ -769,7 +854,7 @@ jobs:
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v1
         with:
-          mdbook-version: '0.3.5'
+          mdbook-version: '0.3.7'
           # mdbook-version: 'latest'
 
       - run: mdbook build
@@ -784,14 +869,8 @@ jobs:
 ### ⭐️ Flutter Web
 
 An exapmle workflow for [Flutter web project].
-Setup [Flutter] with [subosito/flutter-action].
 
-[peanut | Dart Package] is also useful.
-
-[Flutter]: https://github.com/flutter/flutter
 [Flutter web project]: https://flutter.dev/docs/get-started/web
-[subosito/flutter-action]: https://github.com/subosito/flutter-action
-[peanut | Dart Package]: https://pub.dev/packages/peanut
 
 ```yaml
 name: github pages
@@ -808,9 +887,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Flutter
-        uses: subosito/flutter-action@v1
-        with:
-          channel: 'beta'
+        run: |
+          git clone https://github.com/flutter/flutter.git --depth 1 -b beta _flutter
+          echo "::add-path::${GITHUB_WORKSPACE}/_flutter/bin"
 
       - name: Install
         run: |
@@ -829,10 +908,9 @@ jobs:
 
 ### ⭐️ Elm
 
-An exapmle workflow for [Elm] with [justgook/setup-elm].
+An exapmle workflow for [Elm].
 
 [Elm]: https://elm-lang.org
-[justgook/setup-elm]: https://github.com/justgook/setup-elm
 
 ```yaml
 name: github pages
@@ -848,8 +926,13 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+
       - name: Setup Elm
-        uses: justgook/setup-elm@v1
+        run: npm install elm --global
 
       - name: Make
         run: elm make --optimize src/Main.elm
@@ -868,6 +951,80 @@ jobs:
           publish_dir: ./public
 ```
 
+### ⭐️ github/personal-website
+
+- [github/personal-website](https://github.com/github/personal-website) - Code that'll help you kickstart a personal website that showcases your work as a software developer.
+
+```yaml
+# .github/workflows/github-pages.yml
+
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: '24 */24 * * *'  # Once a day
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./
+          allow_empty_commit: true
+          enable_jekyll: true
+          cname: github.peaceiris.com
+```
+
+### ⭐️ Swift Publish
+
+An example workflow for [JohnSundell/Publish].
+
+[JohnSundell/Publish]: https://github.com/JohnSundell/Publish
+
+```yaml
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup JohnSundell/Publish
+        run: |
+          cd ${HOME}
+          git clone --depth=1 https://github.com/JohnSundell/Publish.git
+          cd ./Publish
+          swift build -c release
+          echo "::add-path::${HOME}/Publish/.build/release"
+
+      - run: publish-cli generate
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./Output
+```
+
+<div align="right">
+<a href="#table-of-contents">Back to TOC ☝️</a>
+</div>
+
+
+
 ## License
 
 - [MIT License - peaceiris/actions-gh-pages]
@@ -879,6 +1036,7 @@ jobs:
 ## Maintainer
 
 - [peaceiris homepage](https://peaceiris.com/)
+- [GitHub Action Hero: Shohei Ueda - The GitHub Blog](https://github.blog/2020-03-22-github-action-hero-shohei-ueda/)
 
 
 

__tests__/get-inputs.test.ts

@@ -51,6 +51,7 @@ function getInputsLog(authMethod: string, inps: Inputs): string {
 [INFO] UserName: ${inps.UserName}
 [INFO] UserEmail: ${inps.UserEmail}
 [INFO] CommitMessage: ${inps.CommitMessage}
+[INFO] FullCommitMessage: ${inps.FullCommitMessage}
 [INFO] TagName: ${inps.TagName}
 [INFO] TagMessage: ${inps.TagMessage}
 [INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
@@ -117,6 +118,7 @@ describe('getInputs()', () => {
     expect(inps.UserName).toMatch('');
     expect(inps.UserEmail).toMatch('');
     expect(inps.CommitMessage).toMatch('');
+    expect(inps.FullCommitMessage).toMatch('');
     expect(inps.TagName).toMatch('');
     expect(inps.TagMessage).toMatch('');
     expect(inps.DisableNoJekyll).toBe(false);
@@ -136,6 +138,7 @@ describe('getInputs()', () => {
     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_FULL_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';
@@ -155,12 +158,19 @@ describe('getInputs()', () => {
     expect(inps.UserName).toMatch('username');
     expect(inps.UserEmail).toMatch('github@github.com');
     expect(inps.CommitMessage).toMatch('feat: Add new feature');
+    expect(inps.FullCommitMessage).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('get spec inputs enable_jekyll', () => {
+    process.env['INPUT_ENABLE_JEKYLL'] = 'true';
+    const inps: Inputs = getInputs();
+    expect(inps.DisableNoJekyll).toBe(true);
+  });
+
   test('throw error enable_jekyll or disable_nojekyll', () => {
     process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
     process.env['INPUT_ENABLE_JEKYLL'] = 'true';

__tests__/git-utils.test.ts

@@ -0,0 +1,183 @@
+import {
+  getUserName,
+  getUserEmail,
+  setCommitAuthor,
+  getCommitMessage
+} from '../src/git-utils';
+import {getWorkDirName, createWorkDir} from '../src/utils';
+import {CmdResult} from '../src/interfaces';
+import * as exec from '@actions/exec';
+
+beforeEach(() => {
+  jest.resetModules();
+  process.env['GITHUB_ACTOR'] = 'default-octocat';
+  process.env['GITHUB_REPOSITORY'] = 'owner/repo';
+});
+
+afterEach(() => {
+  delete process.env['GITHUB_ACTOR'];
+  delete process.env['GITHUB_REPOSITORY'];
+});
+
+describe('getUserName()', () => {
+  test('get default git user name', () => {
+    const userName = '';
+    const test = getUserName(userName);
+    expect(test).toMatch('default-octocat');
+  });
+
+  test('get custom git user name', () => {
+    const userName = 'custom-octocat';
+    const test = getUserName(userName);
+    expect(test).toMatch(userName);
+  });
+});
+
+describe('getUserEmail()', () => {
+  test('get default git user email', () => {
+    const userEmail = '';
+    const test = getUserEmail(userEmail);
+    expect(test).toMatch('default-octocat@users.noreply.github.com');
+  });
+
+  test('get custom git user email', () => {
+    const userEmail = 'custom-octocat@github.com';
+    const test = getUserEmail(userEmail);
+    expect(test).toMatch(userEmail);
+  });
+});
+
+describe('setCommitAuthor()', () => {
+  let workDirName = '';
+  (async (): Promise<void> => {
+    const date = new Date();
+    const unixTime = date.getTime();
+    workDirName = await getWorkDirName(`${unixTime}`);
+  })();
+
+  beforeEach(async () => {
+    await createWorkDir(workDirName);
+    process.chdir(workDirName);
+    await exec.exec('git', ['init']);
+  });
+
+  test('get default commit author', async () => {
+    const userName = '';
+    const userEmail = '';
+    const result: CmdResult = {
+      exitcode: 0,
+      output: ''
+    };
+    const options = {
+      listeners: {
+        stdout: (data: Buffer): void => {
+          result.output += data.toString();
+        }
+      }
+    };
+    await setCommitAuthor(userName, userEmail);
+    result.exitcode = await exec.exec('git', ['config', 'user.name'], options);
+    expect(result.output).toMatch('default-octocat');
+    result.exitcode = await exec.exec('git', ['config', 'user.email'], options);
+    expect(result.output).toMatch('default-octocat@users.noreply.github.com');
+  });
+
+  test('get custom commit author', async () => {
+    const userName = 'custom-octocat';
+    const userEmail = 'custom-octocat@github.com';
+    const result: CmdResult = {
+      exitcode: 0,
+      output: ''
+    };
+    const options = {
+      listeners: {
+        stdout: (data: Buffer): void => {
+          result.output += data.toString();
+        }
+      }
+    };
+    await setCommitAuthor(userName, userEmail);
+    result.exitcode = await exec.exec('git', ['config', 'user.name'], options);
+    expect(result.output).toMatch(userName);
+    result.exitcode = await exec.exec('git', ['config', 'user.email'], options);
+    expect(result.output).toMatch(userEmail);
+  });
+
+  test('throw error user_email is undefined', async () => {
+    const userName = 'custom-octocat';
+    const userEmail = '';
+    await expect(setCommitAuthor(userName, userEmail)).rejects.toThrowError(
+      'user_email is undefined'
+    );
+  });
+
+  test('throw error user_name is undefined', async () => {
+    const userName = '';
+    const userEmail = 'custom-octocat@github.com';
+    await expect(setCommitAuthor(userName, userEmail)).rejects.toThrowError(
+      'user_name is undefined'
+    );
+  });
+});
+
+describe('getCommitMessage()', () => {
+  test('get default message', () => {
+    const test = getCommitMessage('', '', '', 'actions/pages', 'commit_hash');
+    expect(test).toMatch('deploy: commit_hash');
+  });
+
+  test('get default message for external repository', () => {
+    const test = getCommitMessage(
+      '',
+      '',
+      'actions/actions.github.io',
+      'actions/pages',
+      'commit_hash'
+    );
+    expect(test).toMatch('deploy: actions/pages@commit_hash');
+  });
+
+  test('get custom message', () => {
+    const test = getCommitMessage(
+      'Custom msg',
+      '',
+      '',
+      'actions/pages',
+      'commit_hash'
+    );
+    expect(test).toMatch('Custom msg commit_hash');
+  });
+
+  test('get custom message for external repository', () => {
+    const test = getCommitMessage(
+      'Custom msg',
+      '',
+      'actions/actions.github.io',
+      'actions/pages',
+      'commit_hash'
+    );
+    expect(test).toMatch('Custom msg actions/pages@commit_hash');
+  });
+
+  test('get full custom message', () => {
+    const test = getCommitMessage(
+      '',
+      'Full custom msg',
+      '',
+      'actions/pages',
+      'commit_hash'
+    );
+    expect(test).toMatch('Full custom msg');
+  });
+
+  test('get full custom message for external repository', () => {
+    const test = getCommitMessage(
+      '',
+      'Full custom msg',
+      'actions/actions.github.io',
+      'actions/pages',
+      'commit_hash'
+    );
+    expect(test).toMatch('Full custom msg');
+  });
+});

__tests__/utils.test.ts

@@ -5,7 +5,8 @@ import {
   getWorkDirName,
   createWorkDir,
   addNoJekyll,
-  addCNAME
+  addCNAME,
+  skipOnFork
 } from '../src/utils';
 
 beforeEach(() => {
@@ -203,3 +204,30 @@ describe('addCNAME()', () => {
     fs.unlinkSync(filepath);
   });
 });
+
+describe('skipOnFork()', () => {
+  test('return false on upstream', async () => {
+    const test = await skipOnFork(false, 'token', '', '');
+    expect(test).toBeFalsy();
+  });
+
+  test('return false on fork with github_token', async () => {
+    const test = await skipOnFork(true, 'token', '', '');
+    expect(test).toBeFalsy();
+  });
+
+  test('return false on fork with deploy_key', async () => {
+    const test = await skipOnFork(true, '', 'deploy_key', '');
+    expect(test).toBeFalsy();
+  });
+
+  test('return false on fork with personal_token', async () => {
+    const test = await skipOnFork(true, '', '', 'personal_token');
+    expect(test).toBeFalsy();
+  });
+
+  test('return true on fork with no tokens', async () => {
+    const test = await skipOnFork(true, '', '', '');
+    expect(test).toBeTruthy();
+  });
+});

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'
@@ -47,7 +47,10 @@ inputs:
     description: 'Set Git user.email'
     required: false
   commit_message:
-    description: 'Set custom commit message'
+    description: 'Set a custom commit message with a triggered commit hash'
+    required: false
+  full_commit_message:
+    description: 'Set a custom full commit message without a triggered commit hash'
     required: false
   tag_name:
     description: 'Set tag name'

package.json

@@ -1,17 +1,18 @@
 {
   "name": "actions-github-pages",
-  "version": "3.5.0",
+  "version": "3.6.1",
   "description": "GitHub Actions for GitHub Pages",
   "main": "lib/index.js",
   "engines": {
-    "node": ">=12.16.1",
-    "npm": ">=6.14.2"
+    "node": ">=12.16.3",
+    "npm": ">=6.14.4"
   },
   "scripts": {
+    "all": "npm run format && npm run lint && npm test",
     "lint": "eslint ./{src,__tests__}/**/*.ts",
     "lint:fix": "eslint --fix ./{src,__tests__}/**/*.ts",
     "test": "jest --coverage --verbose --detectOpenHandles",
-    "build": "ncc build ./src/index.ts -o lib",
+    "build": "ncc build ./src/index.ts -o lib --minify",
     "tsc": "tsc",
     "format": "prettier --write **/*.ts",
     "format:check": "prettier --check **/*.ts",
@@ -29,6 +30,9 @@
     "src/**/*.ts": [
       "prettier --check",
       "eslint"
+    ],
+    "README.md": [
+      "npx doctoc@1.4.0 --github"
     ]
   },
   "repository": {
@@ -50,28 +54,28 @@
   },
   "homepage": "https://github.com/peaceiris/actions-gh-pages#readme",
   "dependencies": {
-    "@actions/core": "^1.2.3",
-    "@actions/exec": "^1.0.3",
+    "@actions/core": "^1.2.4",
+    "@actions/exec": "^1.0.4",
     "@actions/github": "^2.1.1",
     "@actions/io": "^1.0.2"
   },
   "devDependencies": {
-    "@types/jest": "^25.1.3",
-    "@types/js-yaml": "^3.12.2",
+    "@types/jest": "^25.2.1",
+    "@types/js-yaml": "^3.12.3",
     "@types/node": "~12",
-    "@typescript-eslint/eslint-plugin": "^2.22.0",
-    "@typescript-eslint/parser": "^2.22.0",
-    "@zeit/ncc": "^0.21.1",
+    "@typescript-eslint/eslint-plugin": "^2.30.0",
+    "@typescript-eslint/parser": "^2.30.0",
+    "@zeit/ncc": "^0.22.1",
     "eslint": "^6.8.0",
     "eslint-plugin-jest": "^23.8.2",
-    "husky": "^4.2.3",
-    "jest": "^25.1.0",
-    "jest-circus": "^25.1.0",
+    "husky": "^4.2.5",
+    "jest": "^25.5.4",
+    "jest-circus": "^25.5.4",
     "js-yaml": "^3.13.1",
-    "lint-staged": "^10.0.8",
-    "prettier": "1.19.1",
+    "lint-staged": "^10.2.2",
+    "prettier": "2.0.5",
     "standard-version": "^7.1.0",
-    "ts-jest": "^25.2.1",
+    "ts-jest": "^25.4.0",
     "typescript": "^3.8.3"
   }
 }

src/get-inputs.ts

@@ -22,6 +22,7 @@ export function showInputs(inps: Inputs): void {
 [INFO] UserName: ${inps.UserName}
 [INFO] UserEmail: ${inps.UserEmail}
 [INFO] CommitMessage: ${inps.CommitMessage}
+[INFO] FullCommitMessage: ${inps.FullCommitMessage}
 [INFO] TagName: ${inps.TagName}
 [INFO] TagMessage: ${inps.TagMessage}
 [INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
@@ -61,6 +62,7 @@ export function getInputs(): Inputs {
     UserName: core.getInput('user_name'),
     UserEmail: core.getInput('user_email'),
     CommitMessage: core.getInput('commit_message'),
+    FullCommitMessage: core.getInput('full_commit_message'),
     TagName: core.getInput('tag_name'),
     TagMessage: core.getInput('tag_message'),
     DisableNoJekyll: useBuiltinJekyll,

src/git-utils.ts

@@ -1,6 +1,5 @@
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
-import * as github from '@actions/github';
 import * as io from '@actions/io';
 import path from 'path';
 import fs from 'fs';
@@ -103,51 +102,68 @@ export async function setRepo(
   }
 }
 
-export async function setConfig(
+export function getUserName(userName: string): string {
+  if (userName) {
+    return userName;
+  } else {
+    return `${process.env.GITHUB_ACTOR}`;
+  }
+}
+
+export function getUserEmail(userEmail: string): string {
+  if (userEmail) {
+    return userEmail;
+  } else {
+    return `${process.env.GITHUB_ACTOR}@users.noreply.github.com`;
+  }
+}
+
+export async function setCommitAuthor(
   userName: string,
   userEmail: string
 ): Promise<void> {
-  await exec.exec('git', ['config', '--global', 'gc.auto', '0']);
-
-  let name = '';
-  if (userName) {
-    name = userName;
-  } else {
-    name = `${process.env.GITHUB_ACTOR}`;
+  if (userName && !userEmail) {
+    throw new Error('user_email is undefined');
   }
-  await exec.exec('git', ['config', '--global', 'user.name', name]);
-
-  let email = '';
-  if (userName !== '' && userEmail !== '') {
-    email = userEmail;
-  } else {
-    email = `${process.env.GITHUB_ACTOR}@users.noreply.github.com`;
+  if (!userName && userEmail) {
+    throw new Error('user_name is undefined');
   }
-  await exec.exec('git', ['config', '--global', 'user.email', email]);
+  await exec.exec('git', ['config', 'user.name', getUserName(userName)]);
+  await exec.exec('git', ['config', 'user.email', getUserEmail(userEmail)]);
+}
 
-  return;
+export function getCommitMessage(
+  msg: string,
+  fullMsg: string,
+  extRepo: string,
+  baseRepo: string,
+  hash: string
+): string {
+  const msgHash = ((): string => {
+    if (extRepo) {
+      return `${baseRepo}@${hash}`;
+    } else {
+      return hash;
+    }
+  })();
+
+  const subject = ((): string => {
+    if (fullMsg) {
+      return fullMsg;
+    } else if (msg) {
+      return `${msg} ${msgHash}`;
+    } else {
+      return `deploy: ${msgHash}`;
+    }
+  })();
+
+  return subject;
 }
 
 export async function commit(
   allowEmptyCommit: boolean,
-  externalRepository: string,
-  message: string
+  msg: string
 ): Promise<void> {
-  let msg = '';
-  if (message) {
-    msg = message;
-  } else {
-    msg = 'deploy:';
-  }
-
-  const hash = `${process.env.GITHUB_SHA}`;
-  const baseRepo = `${github.context.repo.owner}/${github.context.repo.repo}`;
-  if (externalRepository) {
-    msg = `${msg} ${baseRepo}@${hash}`;
-  } else {
-    msg = `${msg} ${hash}`;
-  }
-
   try {
     if (allowEmptyCommit) {
       await exec.exec('git', ['commit', '--allow-empty', '-m', `${msg}`]);

src/interfaces.ts

@@ -11,6 +11,7 @@ export interface Inputs {
   readonly UserName: string;
   readonly UserEmail: string;
   readonly CommitMessage: string;
+  readonly FullCommitMessage: string;
   readonly TagName: string;
   readonly TagMessage: string;
   readonly DisableNoJekyll: boolean;

src/main.ts

@@ -1,29 +1,67 @@
+import {context} from '@actions/github';
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
+import * as github from '@actions/github';
 import {Inputs} from './interfaces';
 import {showInputs, getInputs} from './get-inputs';
 import {setTokens} from './set-tokens';
-import * as git from './git-utils';
-import {getWorkDirName, addNoJekyll, addCNAME} from './utils';
+import {
+  setRepo,
+  setCommitAuthor,
+  getCommitMessage,
+  commit,
+  push,
+  pushTag
+} from './git-utils';
+import {getWorkDirName, addNoJekyll, addCNAME, skipOnFork} from './utils';
 
 export async function run(): Promise<void> {
   try {
     const inps: Inputs = getInputs();
+    core.startGroup('Dump inputs');
     showInputs(inps);
+    core.endGroup();
 
-    await git.setConfig(inps.UserName, inps.UserEmail);
+    if (core.isDebug()) {
+      core.startGroup('Debug: dump context');
+      console.log(context);
+      core.endGroup();
+    }
 
+    const eventName = context.eventName;
+    if (eventName === 'pull_request' || eventName === 'push') {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const isForkRepository = (context.payload as any).repository.fork;
+      const isSkipOnFork = await skipOnFork(
+        isForkRepository,
+        inps.GithubToken,
+        inps.DeployKey,
+        inps.PersonalToken
+      );
+      if (isSkipOnFork) {
+        core.warning(
+          'This action runs on a fork and not found auth token, Skip deployment'
+        );
+        core.setOutput('skip', 'true');
+        return;
+      }
+    }
+
+    core.startGroup('Setup auth token');
     const remoteURL = await setTokens(inps);
-    core.debug(`[INFO] remoteURL: ${remoteURL}`);
+    core.debug(`remoteURL: ${remoteURL}`);
+    core.endGroup();
 
+    core.startGroup('Prepare publishing assets');
     const date = new Date();
     const unixTime = date.getTime();
     const workDir = await getWorkDirName(`${unixTime}`);
-    await git.setRepo(inps, remoteURL, workDir);
-
+    await setRepo(inps, remoteURL, workDir);
     await addNoJekyll(workDir, inps.DisableNoJekyll, inps.PublishBranch);
     await addCNAME(workDir, inps.CNAME);
+    core.endGroup();
 
+    core.startGroup('Setup Git config');
     try {
       await exec.exec('git', ['remote', 'rm', 'origin']);
     } catch (e) {
@@ -31,14 +69,26 @@ export async function run(): Promise<void> {
     }
     await exec.exec('git', ['remote', 'add', 'origin', remoteURL]);
     await exec.exec('git', ['add', '--all']);
+    await setCommitAuthor(inps.UserName, inps.UserEmail);
+    core.endGroup();
 
-    await git.commit(
-      inps.AllowEmptyCommit,
+    core.startGroup('Create a commit');
+    const hash = `${process.env.GITHUB_SHA}`;
+    const baseRepo = `${github.context.repo.owner}/${github.context.repo.repo}`;
+    const commitMessage = getCommitMessage(
+      inps.CommitMessage,
+      inps.FullCommitMessage,
       inps.ExternalRepository,
-      inps.CommitMessage
+      baseRepo,
+      hash
     );
-    await git.push(inps.PublishBranch, inps.ForceOrphan);
-    await git.pushTag(inps.TagName, inps.TagMessage);
+    await commit(inps.AllowEmptyCommit, commitMessage);
+    core.endGroup();
+
+    core.startGroup('Push the commit or tag');
+    await push(inps.PublishBranch, inps.ForceOrphan);
+    await pushTag(inps.TagName, inps.TagMessage);
+    core.endGroup();
 
     core.info('[INFO] Action successfully completed');
 

src/utils.ts

@@ -62,3 +62,18 @@ export async function addCNAME(
   fs.writeFileSync(filepath, content + '\n');
   core.info(`[INFO] Created ${filepath}`);
 }
+
+export async function skipOnFork(
+  isForkRepository: boolean,
+  githubToken: string,
+  deployKey: string,
+  personalToken: string
+): Promise<boolean> {
+  if (isForkRepository) {
+    if (githubToken === '' && deployKey === '' && personalToken === '') {
+      return true;
+    }
+  }
+
+  return false;
+}