chore(release): 3.0.1

.github/workflows/test-action.yml

@@ -23,11 +23,12 @@ jobs:
     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'
+          - 'macos-latest'
+          - 'windows-latest'
     steps:
 
       - uses: actions/checkout@v2
@@ -66,7 +67,7 @@ jobs:
         with:
           deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
           # github_token: ${{ secrets.GITHUB_TOKEN }}
-          # publish_branch: master
+          # publish_branch: gh-pages
           publish_dir: ./test_projects/mdbook/book
           # external_repository: ''
           allow_empty_commit: true

CHANGELOG.md

@@ -2,6 +2,41 @@
 
 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.0.1](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.0...v3.0.1) (2020-02-05)
+
+
+### docs
+
+* Add link to v2 ([ec95e8e](https://github.com/peaceiris/actions-gh-pages/commit/ec95e8e7aae2075200c33461a0f3aa640d7fbe02))
+* remove Script mode section ([9b3fcdf](https://github.com/peaceiris/actions-gh-pages/commit/9b3fcdf51572449ce5f346724d01e878bd811834))
+* remove v2 example ([a1375a4](https://github.com/peaceiris/actions-gh-pages/commit/a1375a463794f123e06ddb6af0d74ef453d74fa0))
+* update ([1a26eac](https://github.com/peaceiris/actions-gh-pages/commit/1a26eaca33cf4f1d162fc37fd45cab6ea999140e))
+* update for v3 ([1a13108](https://github.com/peaceiris/actions-gh-pages/commit/1a1310886515195d8b9052e68aec5a973dd3779d))
+* update for v3 ([d0de38a](https://github.com/peaceiris/actions-gh-pages/commit/d0de38a352de7896c0bc618c3977f00f6a34151d))
+* update for v3 ([b3cfcb1](https://github.com/peaceiris/actions-gh-pages/commit/b3cfcb13c0e3d5b76fb2b306fafbc0bfdc349e2e))
+* update for v3 ([b1aaa85](https://github.com/peaceiris/actions-gh-pages/commit/b1aaa85b6766b71fd96a06d1ea8a99a5247e7b6c))
+* update for v3 ([f1e7cd6](https://github.com/peaceiris/actions-gh-pages/commit/f1e7cd608c631ec6a3c48e1e76f17b6c8a468ada))
+* update for v3 ([07a3f29](https://github.com/peaceiris/actions-gh-pages/commit/07a3f2915ef742feb191caf4315f92c5dbe24657))
+* update for v3 ([02c3858](https://github.com/peaceiris/actions-gh-pages/commit/02c38586a5b45e217af006473aa99749917bce73))
+* update for v3 ([59bbb98](https://github.com/peaceiris/actions-gh-pages/commit/59bbb98387fa6cde2495176555efd39a3c68b6b5))
+* update for v3 ([be27dcc](https://github.com/peaceiris/actions-gh-pages/commit/be27dcce4894bf0847e64b2ba676b9de08979d21))
+* update for v3 ([ccf71d1](https://github.com/peaceiris/actions-gh-pages/commit/ccf71d1162ce030d5f8aa4bb1e05c45d83912c67))
+* update for v3 ([5fe4aa3](https://github.com/peaceiris/actions-gh-pages/commit/5fe4aa3f24fd2a3f7cf683b04c29895c6882c5de))
+* update for v3 ([428902c](https://github.com/peaceiris/actions-gh-pages/commit/428902c6cd381168d113898fa3fd53e83ca658b2))
+* update for v3 ([00bca7b](https://github.com/peaceiris/actions-gh-pages/commit/00bca7b88cea3a6aff0cd9e90cc297f90981dfe8))
+* update GitHub Actions badge ([9cec798](https://github.com/peaceiris/actions-gh-pages/commit/9cec79845182679864d2e9f2b137c1829773b4a0))
+* update overview ([c940278](https://github.com/peaceiris/actions-gh-pages/commit/c940278a4c780afbd658b4a3f0f7834039913401))
+
+### feat
+
+* Add getHomeDir() for windows (#86) ([ed21b6a](https://github.com/peaceiris/actions-gh-pages/commit/ed21b6a5942b1be9f75103a2661d908d41ed9ea9)), closes [#86](https://github.com/peaceiris/actions-gh-pages/issues/86)
+
+### refactor
+
+* change to core.debug ([9f11da8](https://github.com/peaceiris/actions-gh-pages/commit/9f11da81ae3ead3c8929c35266dd40a0ddfd2bd1))
+
+
+
 # [3.0.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.0.0-1...v3.0.0) (2020-02-05)
 
 

README.md

@@ -1,13 +1,16 @@
 [![license](https://img.shields.io/github/license/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/blob/master/LICENSE)
 [![release](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases/latest)
 [![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/releases)
-![GitHub Actions status](https://github.com/peaceiris/actions-gh-pages/workflows/docker%20image%20ci/badge.svg)
-[![Docker Hub Build Status](https://img.shields.io/docker/cloud/build/peaceiris/gh-pages.svg)](https://hub.docker.com/r/peaceiris/gh-pages)
+![Test Action](https://github.com/peaceiris/actions-gh-pages/workflows/Test%20Action/badge.svg?branch=master&event=push)
 [![Release Feed](https://img.shields.io/badge/release-feed-yellow)](https://github.com/peaceiris/actions-gh-pages/releases.atom)
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=peaceiris/actions-gh-pages)](https://dependabot.com)
 
 <img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="./images/ogp.svg">
 
+> This Action has been migrated to a TypeScript Action (version 3).
+>
+> The old Docker Action is [peaceiris/actions-gh-pages@v2](https://github.com/peaceiris/actions-gh-pages/tree/v2)
+
 
 
 ## GitHub Actions for GitHub Pages
@@ -19,41 +22,27 @@ This deploy action can be combined simply and freely with [Static Site Generator
 
 The next example step will deploy `./public` directory to the remote `gh-pages` branch.
 
+
 ```yaml
 - name: Deploy
-  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
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    # github_token: ${{ secrets.GITHUB_TOKEN }}
+    # personal_token: ${{ secrets.PERSONAL_TOKEN }}
+    publish_dir: ./public
 ```
 
 Three tokens are supported.
 
 | Token | Private repo | Public repo | Protocol | Setup |
 |---|:---:|:---:|---|---|
-| `GITHUB_TOKEN` | ✅️ | (1) | HTTPS | Unnecessary |
-| `PERSONAL_TOKEN` | ✅️ | ✅️ | HTTPS | Necessary |
-| `ACTIONS_DEPLOY_KEY` | ✅️ | ✅️ | SSH | Necessary |
+| `github_token` | ✅️ | (1) | HTTPS | Unnecessary |
+| `personal_token` | ✅️ | ✅️ | HTTPS | Necessary |
+| `deploy_key` | ✅️ | ✅️ | SSH | Necessary |
 
 1. Currently, GitHub Actions does not support to trigger a GitHub Pages build event using GITHUB_TOKEN on a public repository.
 
-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
-```
-
 
 
 ## Table of Contents
@@ -68,17 +57,15 @@ Do you want to skip the docker build step? OK, the script mode is available.
     - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
     - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
 - [Options](#options)
-  - [⭐️ Pull action image from Docker Hub](#%EF%B8%8F-pull-action-image-from-docker-hub)
-  - [⭐️ `PERSONAL_TOKEN`](#%EF%B8%8F-personal_token)
-  - [⭐️ `GITHUB_TOKEN`](#%EF%B8%8F-github_token)
-  - [⭐️ Suppressing empty commits](#%EF%B8%8F-suppressing-empty-commits)
+  - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
+  - [⭐️ `github_token`](#%EF%B8%8F-github_token)
+  - [⭐️ 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)
   - [⭐️ Force orphan](#%EF%B8%8F-force-orphan)
   - [⭐️ Set Git username and email](#%EF%B8%8F-set-git-username-and-email)
   - [⭐️ Set custom commit message](#%EF%B8%8F-set-custom-commit-message)
   - [⭐️ Create Git tag](#%EF%B8%8F-create-git-tag)
-  - [⭐️ 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)
@@ -159,17 +146,16 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-        hugo-version: '0.59.1'
+          hugo-version: '0.64.0'
 
       - name: Build
         run: hugo --minify
 
       - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./public
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
@@ -193,7 +179,7 @@ on:
     branches:
       - source  # default branch
 
-PUBLISH_BRANCH: master  # deploying branch
+publish_branch: master  # deploying branch
 ```
 
 [Project Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#project-pages-sites
@@ -210,113 +196,92 @@ PUBLISH_BRANCH: master  # deploying branch
 
 ## Options
 
-### ⭐️ Pull action image from Docker Hub
-
-You can pull a public docker image from Docker Hub.
-By pulling docker images, you can reduce the overall execution time of your workflow. In addition, `latest` tag is provided.
-
-```diff
-- uses: peaceiris/actions-gh-pages@v2
-+ uses: docker://peaceiris/gh-pages:v2
-```
-
-- [peaceiris/gh-pages - Docker Hub](https://hub.docker.com/r/peaceiris/gh-pages)
-
-### ⭐️ `PERSONAL_TOKEN`
+### ⭐️ `personal_token`
 
 [Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
 
 ```diff
-- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-+ PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
++ personal_token: ${{ secrets.PERSONAL_TOKEN }}
 ```
 
-### ⭐️ `GITHUB_TOKEN`
+### ⭐️ `github_token`
 
-> ⚠️ **NOTES**: `GITHUB_TOKEN` works only on a **private** repository.
+> ⚠️ **NOTES**: `github_token` works only on a **private** repository.
 >
 > This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. GitHub team is investigating that. See [Issue #9]
 
 [Issue #9]: https://github.com/peaceiris/actions-gh-pages/issues/9
 
 ```diff
-- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
++ github_token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-### ⭐️ Suppressing empty commits
+### ⭐️ Allow empty commits
 
-By default, a commit will always be generated and pushed to the `PUBLISH_BRANCH`, even if nothing changed. If you want to suppress this behavior, set the optional parameter `emptyCommits` to `false`. cf. [Issue #21]
-
-[Issue #21]: https://github.com/peaceiris/actions-gh-pages/issues/21
+By default, a commit will not be generated when no file changes. If you want to allow an empty commit, set the optional parameter `allow_empty_commit` to `true`.
 
 For example:
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2
-  env:
-    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    PUBLISH_BRANCH: gh-pages
-    PUBLISH_DIR: ./public
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    emptyCommits: false
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    allow_empty_commit: true
 ```
 
 ### ⭐️ Keeping existing files
 
-By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keepFiles` to `true`.
+By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`.
 
 For example:
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2
-  env:
-    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    PUBLISH_BRANCH: gh-pages
-    PUBLISH_DIR: ./public
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    keepFiles: true
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    keep_files: true
 ```
 
 ### ⭐️ Deploy to external repository
 
 By default, your files are published to the repository which is running this action.
-If you want to publish to another repository on GitHub, set the environment variable `EXTERNAL_REPOSITORY` to `<username>/<external-repository>`.
-This option is available from `v2.5.0`.
+If you want to publish to another repository on GitHub, set the environment variable `external_repository` to `<username>/<external-repository>`.
 
 For example:
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2
-  env:
-    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    EXTERNAL_REPOSITORY: username/external-repository
-    PUBLISH_BRANCH: gh-pages
-    PUBLISH_DIR: ./public
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    external_repository: username/external-repository
+    publish_branch: gh-pages
+    publish_dir: ./public
 ```
 
-You can use `ACTIONS_DEPLOY_KEY` or `PERSONAL_TOKEN`.
-When you use `ACTIONS_DEPLOY_KEY`, set your private key to the repository which includes this action and set your public key to your external repository.
+You can use `deploy_key` or `personal_token`.
+When you use `deploy_key`, set your private key to the repository which includes this action and set your public key to your external repository.
 
 Be careful, `GITHUB_TOKEN` has no permission to access to external repositories.
 
 ### ⭐️ Force orphan
 
-From `v2.6.0`, we can set the `forceOrphan: true` option.
+We can set the `force_orphan: 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
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    forceOrphan: true
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    force_orphan: true
 ```
 
 ### ⭐️ Set Git username and email
@@ -326,14 +291,12 @@ A commit is always created with the same user.
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2
-  env:
-    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    PUBLISH_BRANCH: gh-pages
-    PUBLISH_DIR: ./public
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    username: "iris"
-    useremail: "iris@peaceiris.com"
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    user_name: iris
+    user_email: iris@peaceiris.com
 ```
 
 ### ⭐️ Set custom commit message
@@ -343,13 +306,11 @@ When we create a commit with a message `docs: Update some post`, a deployment co
 
 ```yaml
 - name: Deploy
-  uses: peaceiris/actions-gh-pages@v2
-  env:
-    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    PUBLISH_BRANCH: gh-pages
-    PUBLISH_DIR: ./public
+  uses: peaceiris/actions-gh-pages@v3
   with:
-    commitMessage: ${{ github.event.head_commit.message }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    publish_dir: ./public
+    commit_message: ${{ github.event.head_commit.message }}
 ```
 
 ### ⭐️ Create Git tag
@@ -383,14 +344,12 @@ jobs:
           echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"
 
       - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./public
+        uses: peaceiris/actions-gh-pages@v3
         with:
-        tagName: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
-        tagMessage: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
+          tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
+          tag_message: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'
 ```
 
 Commands on a local machine.
@@ -407,28 +366,6 @@ deploy-v1.2.3  # Tag on the gh-pages branch
 v1.2.3         # Tag on the master branch
 ```
 
-We can set `tagOverwrite` option to `true` for overwriting a tag.
-
-### ⭐️ 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>
@@ -466,9 +403,9 @@ Does not your static site generator deal with the static files? No problem, you
 
 ### ⭐️ Deployment completed but you cannot read
 
-Does your `PUBLISH_DIR` contain files or directories that name starts with an underscore? (`_modules`, `_sources` and `_next`, etc.)
+Does your `publish_dir` contain files or directories that name starts with an underscore? (`_modules`, `_sources` and `_next`, etc.)
 GitHub Pages does not read those by default.
-Please add `.nojekyll` file to `PUBLISH_DIR`.
+Please add `.nojekyll` file to `publish_dir`.
 
 - [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
 
@@ -516,10 +453,10 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup Node
         uses: actions/setup-node@v1
@@ -539,11 +476,10 @@ jobs:
       - run: npm run build
 
       - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./public
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 ### ⭐️ Gatsby
@@ -564,10 +500,10 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup Node
         uses: actions/setup-node@v1
@@ -591,11 +527,10 @@ jobs:
       - run: npm run build
 
       - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./public
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 ### ⭐️ React and Next
@@ -618,10 +553,10 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup Node
         uses: actions/setup-node@v1
@@ -648,12 +583,11 @@ jobs:
 
       - run: touch ./out/.nojekyll
 
-    - name: deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./out
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./out
 ```
 
 ### ⭐️ Vue and Nuxt
@@ -676,10 +610,10 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup Node
         uses: actions/setup-node@v1
@@ -701,11 +635,10 @@ jobs:
       - run: npm run generate
 
       - name: deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./dist
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./dist
 ```
 
 ### ⭐️ Static Site Generators with Python
@@ -729,10 +662,10 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup Python
         uses: actions/setup-python@v1
@@ -756,11 +689,10 @@ jobs:
       - run: mkdocs build
 
       - name: Deploy
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./site
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./site
 ```
 
 ### ⭐️ mdBook (Rust)
@@ -783,10 +715,7 @@ jobs:
   deploy:
     runs-on: ubuntu-18.04
     steps:
-
-    - uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
+      - uses: actions/checkout@v2
 
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v1
@@ -797,11 +726,10 @@ jobs:
       - 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
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./book
 ```
 
 ### ⭐️ Flutter Web
@@ -825,10 +753,10 @@ on:
       - master
 
 jobs:
-  build-deploy:
+  deploy:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup Flutter
         uses: subosito/flutter-action@v1
@@ -844,11 +772,10 @@ jobs:
         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
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./build/web
 ```
 
 ### ⭐️ Elm
@@ -867,8 +794,8 @@ on:
       - master
 
 jobs:
-  build-deploy:
-    runs-on: ubuntu-latest
+  deploy:
+    runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
 
@@ -886,11 +813,10 @@ jobs:
         # provide --output=<output-file> option for `elm make` and remove this step
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v2
-        env:
-          ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-          PUBLISH_BRANCH: gh-pages
-          PUBLISH_DIR: ./public
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./public
 ```
 
 ## License

lib/index.js

@@ -3188,7 +3188,7 @@ function run() {
             const inps = get_inputs_1.getInputs();
             yield git.setConfig(inps.UserName, inps.UserEmail);
             const remoteURL = yield set_tokens_1.setTokens(inps);
-            core.info(`[INFO] remoteURL: ${remoteURL}`);
+            core.debug(`[INFO] remoteURL: ${remoteURL}`);
             yield git.setRepo(inps, remoteURL);
             try {
                 yield exec.exec('git', ['remote', 'rm', 'origin']);
@@ -10983,7 +10983,20 @@ const github = __importStar(__webpack_require__(469));
 const io = __importStar(__webpack_require__(1));
 const path_1 = __importDefault(__webpack_require__(622));
 const fs_1 = __importDefault(__webpack_require__(747));
+const cpSpawnSync = __webpack_require__(129).spawnSync;
 const cpexec = __webpack_require__(129).execFileSync;
+function getHomeDir() {
+    let homedir = '';
+    if (process.platform === 'win32') {
+        homedir = process.env['USERPROFILE'] || 'C:\\';
+    }
+    else {
+        homedir = `${process.env.HOME}`;
+    }
+    core.debug(`homeDir: ${homedir}`);
+    return homedir;
+}
+exports.getHomeDir = getHomeDir;
 function setPublishRepo(insp) {
     if (insp.ExternalRepository) {
         return insp.ExternalRepository;
@@ -10994,7 +11007,8 @@ exports.setPublishRepo = setPublishRepo;
 function setSSHKey(inps, publishRepo) {
     return __awaiter(this, void 0, void 0, function* () {
         core.info('[INFO] setup SSH deploy key');
-        const sshDir = path_1.default.join(`${process.env.HOME}`, '.ssh');
+        const homeDir = getHomeDir();
+        const sshDir = path_1.default.join(homeDir, '.ssh');
         yield io.mkdirP(sshDir);
         yield exec.exec('chmod', ['700', sshDir]);
         const knownHosts = path_1.default.join(sshDir, 'known_hosts');
@@ -11019,6 +11033,12 @@ Host github
         fs_1.default.writeFileSync(sshConfigPath, sshConfigContent + '\n');
         core.info(`[INFO] wrote ${sshConfigPath}`);
         yield exec.exec('chmod', ['600', sshConfigPath]);
+        if (process.platform === 'win32') {
+            yield cpSpawnSync('Start-Process', ['powershell.exe', '-Verb', 'runas']);
+            yield cpSpawnSync('sh', ['-c', '\'eval "$(ssh-agent)"\''], { shell: true });
+            yield exec.exec('sc', ['config', 'ssh-agent', 'start=auto']);
+            yield exec.exec('sc', ['start', 'ssh-agent']);
+        }
         yield cpexec('ssh-agent', ['-a', '/tmp/ssh-auth.sock']);
         core.exportVariable('SSH_AUTH_SOCK', '/tmp/ssh-auth.sock');
         yield exec.exec('ssh-add', [idRSA]);

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "actions-github-pages",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "actions-github-pages",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "GitHub Actions for GitHub Pages",
   "main": "lib/index.js",
   "engines": {

src/main.ts

@@ -12,7 +12,7 @@ export async function run(): Promise<void> {
     await git.setConfig(inps.UserName, inps.UserEmail);
 
     const remoteURL = await setTokens(inps);
-    core.info(`[INFO] remoteURL: ${remoteURL}`); // TODO: remove
+    core.debug(`[INFO] remoteURL: ${remoteURL}`);
 
     await git.setRepo(inps, remoteURL);
 

src/set-tokens.ts

@@ -4,9 +4,24 @@ import * as github from '@actions/github';
 import * as io from '@actions/io';
 import path from 'path';
 import fs from 'fs';
+const cpSpawnSync = require('child_process').spawnSync;
 const cpexec = require('child_process').execFileSync;
 import {Inputs} from './interfaces';
 
+export function getHomeDir(): string {
+  let homedir = '';
+
+  if (process.platform === 'win32') {
+    homedir = process.env['USERPROFILE'] || 'C:\\';
+  } else {
+    homedir = `${process.env.HOME}`;
+  }
+
+  core.debug(`homeDir: ${homedir}`);
+
+  return homedir;
+}
+
 export function setPublishRepo(insp: Inputs): string {
   if (insp.ExternalRepository) {
     return insp.ExternalRepository;
@@ -20,7 +35,8 @@ export async function setSSHKey(
 ): Promise<string> {
   core.info('[INFO] setup SSH deploy key');
 
-  const sshDir = path.join(`${process.env.HOME}`, '.ssh');
+  const homeDir = getHomeDir();
+  const sshDir = path.join(homeDir, '.ssh');
   await io.mkdirP(sshDir);
   await exec.exec('chmod', ['700', sshDir]);
 
@@ -50,6 +66,12 @@ Host github
   core.info(`[INFO] wrote ${sshConfigPath}`);
   await exec.exec('chmod', ['600', sshConfigPath]);
 
+  if (process.platform === 'win32') {
+    await cpSpawnSync('Start-Process', ['powershell.exe', '-Verb', 'runas']);
+    await cpSpawnSync('sh', ['-c', '\'eval "$(ssh-agent)"\''], {shell: true});
+    await exec.exec('sc', ['config', 'ssh-agent', 'start=auto']);
+    await exec.exec('sc', ['start', 'ssh-agent']);
+  }
   await cpexec('ssh-agent', ['-a', '/tmp/ssh-auth.sock']);
   core.exportVariable('SSH_AUTH_SOCK', '/tmp/ssh-auth.sock');
   await exec.exec('ssh-add', [idRSA]);