feat: Add username and useremail options

Close #66

.dependabot/config.yml

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

.github/CODEOWNERS

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

.github/FUNDING.yml

@@ -1,9 +0,0 @@
-# These are supported funding model platforms
-
-# github: peaceiris
-patreon: peaceiris
-issuehunt: peaceiris
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-custom: # Replace with a single custom sponsorship URL

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/proposal.md

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

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

@@ -3,40 +3,38 @@ name: docker image ci
 on:
   pull_request:
     types: [opened, synchronize]
+    paths-ignore:
+    - '**.md'
   push:
+    paths-ignore:
+    - '**.md'
+    branches:
+    - master
 
 jobs:
   test:
     runs-on: ubuntu-18.04
 
     steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 1
+    - uses: actions/checkout@v2
 
     - name: build
       env:
         DOCKER_IMAGE: docker.pkg.github.com/${{ github.repository }}/action:latest
       run: |
-        docker build . --file Dockerfile --tag ${DOCKER_IMAGE} ||
-        (echo -e "\e[31m[${GITHUB_WORKFLOW}] failed to build\e[m" && exit 1)
+        docker build . --file Dockerfile --tag ${DOCKER_IMAGE}
 
   shellcheck:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 1
+    - uses: actions/checkout@v2
+
     - name: shellcheck
       run: shellcheck ./entrypoint.sh
 
   hadolint:
-    runs-on: macOS-10.14
+    runs-on: macos-latest
     steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 1
-    - name: hadolint
-      run: |
-        brew install hadolint
-        hadolint ./Dockerfile
+    - uses: actions/checkout@v2
+    - run: brew install hadolint
+    - run: hadolint ./Dockerfile

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

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

.github/workflows/stale.yml

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

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

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

Dockerfile

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

README.md

@@ -1,7 +1,7 @@
 [![license](https://img.shields.io/github/license/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/blob/master/LICENSE)
 [![release](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases/latest)
 [![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases)
-[![GitHub Actions status](https://github.com/peaceiris/actions-gh-pages/workflows/docker%20image%20ci/badge.svg)](https://github.com/peaceiris/actions-gh-pages/actions)
+![GitHub Actions status](https://github.com/peaceiris/actions-gh-pages/workflows/docker%20image%20ci/badge.svg)
 [![Docker Hub Build Status](https://img.shields.io/docker/cloud/build/peaceiris/gh-pages.svg)](https://hub.docker.com/r/peaceiris/gh-pages)
 
 <img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="./images/ogp.svg">
@@ -11,20 +11,44 @@
 ## GitHub Actions for GitHub Pages
 
 This is a **GitHub Action** to deploy your static files to **GitHub Pages**.
-This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, etc.)
+This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, mdBook, etc.)
 
 [Static Site Generators]: https://www.staticgen.com/
 
+The next example step will deploy `./public` directory to the remote `gh-pages` branch.
+
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2.4.0
+  uses: peaceiris/actions-gh-pages@v2
   env:
     ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    # PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+    # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     PUBLISH_BRANCH: gh-pages
     PUBLISH_DIR: ./public
 ```
 
-The above example step will deploy `./public` directory to `gh-pages` branch.
+Three tokens are supported.
+
+| Token | Private repo | Public repo | Protocol | Setup |
+|---|:---:|:---:|---|---|
+| `GITHUB_TOKEN` | ✅️ | ❌️ | HTTPS | Unnecessary |
+| `PERSONAL_TOKEN` | ✅️ | ✅️ | HTTPS | Necessary |
+| `ACTIONS_DEPLOY_KEY` | ✅️ | ✅️ | SSH | Necessary |
+
+Do you want to skip the docker build step? OK, the script mode is available.
+
+```yaml
+- name: Deploy
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+    SCRIPT_MODE: true
+  run: |
+    wget https://raw.githubusercontent.com/peaceiris/actions-gh-pages/v2/entrypoint.sh
+    bash ./entrypoint.sh
+```
 
 
 
@@ -46,6 +70,8 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
   - [⭐️ Suppressing empty commits](#%EF%B8%8F-suppressing-empty-commits)
   - [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
   - [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
+  - [⭐️ Force orphan](#%EF%B8%8F-force-orphan)
+  - [⭐️ Script mode](#%EF%B8%8F-script-mode)
 - [Tips and FAQ](#tips-and-faq)
   - [⭐️ Use the latest and specific release](#%EF%B8%8F-use-the-latest-and-specific-release)
   - [⭐️ How to add `CNAME`](#%EF%B8%8F-how-to-add-cname)
@@ -56,6 +82,8 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
   - [⭐️ React and Next](#%EF%B8%8F-react-and-next)
   - [⭐️ Vue and Nuxt](#%EF%B8%8F-vue-and-nuxt)
   - [⭐️ Static Site Generators with Python](#%EF%B8%8F-static-site-generators-with-python)
+  - [⭐️ mdBook (Rust)](#%EF%B8%8F-mdbook-rust)
+  - [⭐️ Flutter Web](#%EF%B8%8F-flutter-web)
 - [License](#license)
 - [About the author](#about-the-author)
 
@@ -116,20 +144,20 @@ jobs:
   build-deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v1
       # with:
       #   submodules: true
 
     - name: Setup Hugo
-      uses: peaceiris/actions-hugo@v2.2.1
+      uses: peaceiris/actions-hugo@v2
       with:
-        hugo-version: '0.58.3'
+        hugo-version: '0.59.1'
 
     - name: Build
-      run: hugo --gc --minify --cleanDestinationDir
+      run: hugo --minify
 
     - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2.4.0
+      uses: peaceiris/actions-gh-pages@v2
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -164,6 +192,7 @@ PUBLISH_BRANCH: master  # deploying branch
 [User and Organization Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#user-and-organization-pages-sites
 
 ![Change default branch](./images/default-branch.jpg)
+![Change default branch](./images/user_repo.jpg)
 
 <div align="right">
 <a href="#table-of-contents">Back to TOC ☝️</a>
@@ -179,8 +208,8 @@ You can pull a public docker image from Docker Hub.
 By pulling docker images, you can reduce the overall execution time of your workflow. In addition, `latest` tag is provided.
 
 ```diff
-- uses: peaceiris/actions-gh-pages@v2.4.0
-+ uses: docker://peaceiris/gh-pages:v2.4.0
+- uses: peaceiris/actions-gh-pages@v2
++ uses: docker://peaceiris/gh-pages:v2
 ```
 
 - [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
@@ -196,7 +225,7 @@ By pulling docker images, you can reduce the overall execution time of your work
 
 ### ⭐️ `GITHUB_TOKEN`
 
-> **NOTES**: Do not use `GITHUB_TOKEN`.
+> ⚠️ **NOTES**: `GITHUB_TOKEN` works only on a **private** repository.
 >
 > This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. GitHub team is investigating that. See [Issue #9]
 
@@ -217,7 +246,7 @@ For example:
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2.4.0
+  uses: peaceiris/actions-gh-pages@v2
   env:
     ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
     PUBLISH_BRANCH: gh-pages
@@ -234,7 +263,7 @@ For example:
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2.4.0
+  uses: peaceiris/actions-gh-pages@v2
   env:
     ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
     PUBLISH_BRANCH: gh-pages
@@ -247,16 +276,17 @@ For example:
 
 By default, your files are published to the repository which is running this action.
 If you want to publish to another repository on GitHub, set the environment variable `EXTERNAL_REPOSITORY` to `<username>/<external-repository>`.
+This option is available from `v2.5.0`.
 
 For example:
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2.4.0
+  uses: peaceiris/actions-gh-pages@v2
   env:
     ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    EXTERNAL_REPOSITORY: username/username.github.io
-    PUBLISH_BRANCH: master
+    EXTERNAL_REPOSITORY: username/external-repository
+    PUBLISH_BRANCH: gh-pages
     PUBLISH_DIR: ./public
 ```
 
@@ -265,6 +295,42 @@ When you use `ACTIONS_DEPLOY_KEY`, set your private key to the repository which
 
 Be careful, `GITHUB_TOKEN` has no permission to access to external repositories.
 
+### ⭐️ Force orphan
+
+From `v2.6.0`, we can set the `forceOrphan: true` option.
+This allows you to make your publish branch with only the latest commit.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v2
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+  with:
+    forceOrphan: true
+```
+
+### ⭐️ Script mode
+
+From `v2.5.0`, we can run this action as a shell script.
+There is no Docker build or pull step, so it will start immediately.
+
+- `ACTIONS_DEPLOY_KEY` requires `SCRIPT_MODE: true`
+- `*_TOKEN` do not require `SCRIPT_MODE`
+
+```yaml
+- name: Deploy
+  env:
+    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    PUBLISH_BRANCH: gh-pages
+    PUBLISH_DIR: ./public
+    SCRIPT_MODE: true
+  run: |
+    wget https://raw.githubusercontent.com/peaceiris/actions-gh-pages/v2/entrypoint.sh
+    bash ./entrypoint.sh
+```
+
 <div align="right">
 <a href="#table-of-contents">Back to TOC ☝️</a>
 </div>
@@ -355,18 +421,27 @@ jobs:
   build-deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v1
 
-    - name: build
+    - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
-    - run: |
-        npm install
-        npm run build
+        node-version: '10.x'
 
-    - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.4.0
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+
+    - run: npm ci
+
+    - run: npm run build
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -394,27 +469,31 @@ jobs:
   build-deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v1
 
-    - name: setup node
+    - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
 
-    - name: install
-      run: npm install
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
 
-    - name: format
-      run: npm run format
+    - run: npm ci
 
-    - name: test
-      run: npm run test
+    - run: npm run format
 
-    - name: build
-      run: npm run build
+    - run: npm run test
 
-    - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.4.0
+    - run: npm run build
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -444,27 +523,35 @@ jobs:
   build-deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v1
 
-    - name: setup node
+    - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
 
-    - name: install
-      run: yarn install
+    - name: Get yarn cache
+      id: yarn-cache
+      run: echo "::set-output name=dir::$(yarn cache dir)"
 
-    - name: build
-      run: yarn build
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ${{ steps.yarn-cache.outputs.dir }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
 
-    - name: export
-      run: yarn export
+    - run: yarn install
 
-    - name: add nojekyll
-      run: touch ./out/.nojekyll
+    - run: yarn build
+
+    - run: yarn export
+
+    - run: touch ./out/.nojekyll
 
     - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.4.0
+      uses: peaceiris/actions-gh-pages@v2
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -494,24 +581,29 @@ jobs:
   build-deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v1
 
-    - name: setup node
+    - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: '10.16'
+        node-version: '10.x'
 
-    - name: install
-      run: npm install
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
 
-    - name: test
-      run: npm test
+    - run: npm ci
 
-    - name: generate
-      run: npm run generate
+    - run: npm test
+
+    - run: npm run generate
 
     - name: deploy
-      uses: peaceiris/actions-gh-pages@v2.4.0
+      uses: peaceiris/actions-gh-pages@v2
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
@@ -544,29 +636,119 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Set up Python
+    - name: Setup Python
       uses: actions/setup-python@v1
       with:
         python-version: '3.6'
         architecture: 'x64'
 
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
     - name: Install dependencies
       run: |
-        pip install --upgrade pip
-        pip install -r ./requirements.txt
+        python3 -m pip install --upgrade pip
+        python3 -m pip install -r ./requirements.txt
 
-    - name: Build
-      run: mkdocs build
+    - run: mkdocs build
 
     - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2.4.0
+      uses: peaceiris/actions-gh-pages@v2
       env:
         ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: ./site
 ```
 
+### ⭐️ mdBook (Rust)
 
+An example GitHub Actions workflow to deploy [rust-lang/mdBook] site to GitHub Pages.
+
+[rust-lang/mdBook]: https://github.com/rust-lang/mdBook
+
+- [peaceiris/actions-mdbook: GitHub Actions for mdBook (rust-lang/mdBook)](https://github.com/peaceiris/actions-mdbook)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+
+    - name: Setup mdBook
+      uses: peaceiris/actions-mdbook@v1
+      with:
+        mdbook-version: '0.3.5'
+        # mdbook-version: 'latest'
+
+    - run: mdbook build
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./book
+```
+
+### ⭐️ Flutter Web
+
+An exapmle workflow for [Flutter web project].
+Setup [Flutter] with [subosito/flutter-action].
+
+[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
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Setup Flutter
+      uses: subosito/flutter-action@v1
+      with:
+        channel: 'beta'
+
+    - name: Install
+      run: |
+        flutter config --enable-web
+        flutter pub get
+
+    - name: Build
+      run: flutter build web
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./build/web
+```
 
 ## License
 

action.yml

@@ -1,4 +1,4 @@
-name: 'Deploy action for GitHub Pages'
+name: 'GitHub Pages action'
 description: 'GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.'
 author: 'peaceiris'
 runs:
@@ -16,3 +16,13 @@ inputs:
     description: 'If existing files in the publish branch should be not removed before deploying'
     required: false
     default: 'false'
+  forceOrphan:
+    description: 'Keep only the latest commit on a GitHub Pages branch'
+    required: false
+    default: 'false'
+  username:
+    description: 'Set Git user.name'
+    required: false
+  useremail:
+    description: 'Set Git user.email'
+    required: false

entrypoint.sh

@@ -28,10 +28,16 @@ if [ -n "${ACTIONS_DEPLOY_KEY}" ]; then
 
     print_info "setup with ACTIONS_DEPLOY_KEY"
 
-    mkdir /root/.ssh
-    ssh-keyscan -t rsa github.com > /root/.ssh/known_hosts
-    echo "${ACTIONS_DEPLOY_KEY}" > /root/.ssh/id_rsa
-    chmod 400 /root/.ssh/id_rsa
+    if [ -n "${SCRIPT_MODE}" ]; then
+        print_info "run as SCRIPT_MODE"
+        SSH_DIR="${HOME}/.ssh"
+    else
+        SSH_DIR="/root/.ssh"
+    fi
+    mkdir "${SSH_DIR}"
+    ssh-keyscan -t rsa github.com > "${SSH_DIR}/known_hosts"
+    echo "${ACTIONS_DEPLOY_KEY}" > "${SSH_DIR}/id_rsa"
+    chmod 400 "${SSH_DIR}/id_rsa"
 
     remote_repo="git@github.com:${PUBLISH_REPOSITORY}.git"
 
@@ -44,7 +50,7 @@ elif [ -n "${PERSONAL_TOKEN}" ]; then
 elif [ -n "${GITHUB_TOKEN}" ]; then
 
     print_info "setup with GITHUB_TOKEN"
-    print_error "Do not use GITHUB_TOKEN, See #9"
+    print_error "GITHUB_TOKEN works only private repo, See #9"
 
     if [ -n "${EXTERNAL_REPOSITORY}" ]; then
         print_error "can not use GITHUB_TOKEN to deploy to a external repository"
@@ -70,8 +76,14 @@ fi
 
 remote_branch="${PUBLISH_BRANCH}"
 
-local_dir="${HOME}/$(tr -cd 'a-f0-9' < /dev/urandom | head -c 32)"
-if git clone --depth=1 --single-branch --branch "${remote_branch}" "${remote_repo}" "${local_dir}"; then
+local_dir="${HOME}/ghpages_${RANDOM}"
+
+if [[ "${INPUT_FORCEORPHAN}" == "true" ]]; then
+    print_info "force ophan: ${INPUT_FORCEORPHAN}"
+    cd "${PUBLISH_DIR}"
+    git init
+    git checkout --orphan "${remote_branch}"
+elif git clone --depth=1 --single-branch --branch "${remote_branch}" "${remote_repo}" "${local_dir}"; then
     cd "${local_dir}"
 
     if [[ ${INPUT_KEEPFILES} == "true" ]]; then
@@ -90,8 +102,16 @@ else
 fi
 
 # push to publishing branch
-git config user.name "${GITHUB_ACTOR}"
-git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+if [[ -n "${INPUT_USERNAME}" ]]; then
+    git config user.name "${INPUT_USERNAME}"
+else
+    git config user.name "${GITHUB_ACTOR}"
+fi
+if [[ -n "${INPUT_USEREMAIL}" ]]; then
+    git config user.email "${INPUT_USEREMAIL}"
+else
+    git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+fi
 git remote rm origin || true
 git remote add origin "${remote_repo}"
 git add --all
@@ -104,5 +124,10 @@ else
     git commit --allow-empty -m "${COMMIT_MESSAGE}"
 fi
 
-git push origin "${remote_branch}"
+if [[ ${INPUT_FORCEORPHAN} == "true" ]]; then
+    git push origin --force "${remote_branch}"
+else
+    git push origin "${remote_branch}"
+fi
+
 print_info "${GITHUB_SHA} was successfully deployed"