chore(release): 3.3.0-0

chore(release): Add build assets
chore: Add vim
2020-02-21 01:34:32 +09:00 · 2020-02-21 01:34:31 +09:00 · 2020-02-21 01:27:06 +09:00 · 2020-02-20 16:10:11 +00:00
8 changed files with 178 additions and 205 deletions
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -62,7 +62,3 @@ jobs:
        with:
          name: coverage
          path: coverage
-
-      - uses: codecov/codecov-action@v1
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,38 +2,6 @@

 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.4.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.3.0...v3.4.0) (2020-02-24)
-
-
-### deps
-
-* bump eslint-plugin-jest from 23.7.0 to 23.8.0 (#124) ([e0af1f7](https://github.com/peaceiris/actions-gh-pages/commit/e0af1f7de04642a5e810c38b24abd507d81b86be)), closes [#124](https://github.com/peaceiris/actions-gh-pages/issues/124)
-
-### docs
-
-* Put github_token as first example (#115) ([62e7849](https://github.com/peaceiris/actions-gh-pages/commit/62e7849d7ab5a2167baf529dc8fd9034fcf41c43)), closes [#115](https://github.com/peaceiris/actions-gh-pages/issues/115)
-* update ([7b12ca9](https://github.com/peaceiris/actions-gh-pages/commit/7b12ca9aebe1ddcf25dc1c6fd793308e703b4ec7))
-
-
-
-# [3.3.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.2.0...v3.3.0) (2020-02-24)
-
-
-### deps
-
-* bump @actions/github from 2.1.0 to 2.1.1 (#120) ([5d3cd50](https://github.com/peaceiris/actions-gh-pages/commit/5d3cd509d9e8ab8ba8b6c6981eb8ecb077ab2109)), closes [#120](https://github.com/peaceiris/actions-gh-pages/issues/120)
-* bump @types/jest from 25.1.2 to 25.1.3 (#118) ([0b1dd44](https://github.com/peaceiris/actions-gh-pages/commit/0b1dd44709acc2ba27cf43e181767b92e78d1577)), closes [#118](https://github.com/peaceiris/actions-gh-pages/issues/118)
-* bump @types/node from 12.12.27 to 12.12.28 (#122) ([b243caf](https://github.com/peaceiris/actions-gh-pages/commit/b243cafb6e6598d71925399552d569a628a42aa7)), closes [#122](https://github.com/peaceiris/actions-gh-pages/issues/122)
-* bump @zeit/ncc from 0.21.0 to 0.21.1 (#101) ([6244b19](https://github.com/peaceiris/actions-gh-pages/commit/6244b197b6c5a57172d87769cd03d79cedae9dca)), closes [#101](https://github.com/peaceiris/actions-gh-pages/issues/101)
-* bump ts-jest from 25.2.0 to 25.2.1 (#117) ([e1bf32a](https://github.com/peaceiris/actions-gh-pages/commit/e1bf32ad68fadb9a32147579d6dc49b51d6ddefb)), closes [#117](https://github.com/peaceiris/actions-gh-pages/issues/117)
-* bump typescript from 3.7.5 to 3.8.2 (#121) ([e58a6c1](https://github.com/peaceiris/actions-gh-pages/commit/e58a6c156e7249d4e6052539e2ed0aa449bdd4f4)), closes [#121](https://github.com/peaceiris/actions-gh-pages/issues/121)
-
-### feat
-
-* Add disable_nojekyll and cname options (#119) ([00fde1e](https://github.com/peaceiris/actions-gh-pages/commit/00fde1eb97e54d4fa89f31806ff2815878fafcb6)), closes [#119](https://github.com/peaceiris/actions-gh-pages/issues/119) [/github.com/peaceiris/actions-gh-pages/issues/112#issuecomment-589678269](https://github.com//github.com/peaceiris/actions-gh-pages/issues/112/issues/issuecomment-589678269) [#112](https://github.com/peaceiris/actions-gh-pages/issues/112)
-
-
-
 # [3.3.0-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.2.0...v3.3.0-0) (2020-02-20)


--- a/README.md
+++ b/README.md
@@ -28,7 +28,9 @@ The next example step will deploy `./public` directory to the remote `gh-pages`
 - name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+    # github_token: ${{ secrets.GITHUB_TOKEN }}
+    # personal_token: ${{ secrets.PERSONAL_TOKEN }}
    publish_dir: ./public
 ```

@@ -38,17 +40,19 @@ Three tokens are supported.

 | Token | Private repo | Public repo | Protocol | Setup |
 |---|:---:|:---:|---|---|
-| `github_token` | ✅️ | ✅️ | HTTPS | Unnecessary |
-| `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.~~ Maybe, we can use it but there is no official announcement by GitHub.

 ### Supported Platforms

-| runs-on | `github_token` | `deploy_key` | `personal_token` |
+| runs-on | `deploy_key` | `github_token` | `personal_token` |
 |---|:---:|:---:|:---:|
 | ubuntu-18.04 | ✅️ | ✅️ | ✅️ |
 | macos-latest | ✅️ | ✅️ | ✅️ |
-| windows-latest | ✅️ | (2) | ✅️ |
+| windows-latest | (2) | ✅️ | ✅️ |

 2. WIP, See [Issue #87](https://github.com/peaceiris/actions-gh-pages/issues/87)

@@ -61,13 +65,13 @@ Three tokens are supported.


 - [Getting started](#getting-started)
-  - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
-  - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
+  - [(1) Add SSH deploy key](#1-add-ssh-deploy-key)
+  - [(2) Create your workflow](#2-create-your-workflow)
+    - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
+    - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
 - [Options](#options)
-  - [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
  - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
-  - [⭐️ CNAME](#%EF%B8%8F-cname)
-  - [⭐️ Disable `.nojekyll`](#%EF%B8%8F-disable-nojekyll)
+  - [⭐️ `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)
@@ -76,8 +80,9 @@ Three tokens are supported.
  - [⭐️ Set custom commit message](#%EF%B8%8F-set-custom-commit-message)
  - [⭐️ Create Git tag](#%EF%B8%8F-create-git-tag)
 - [Tips and FAQ](#tips-and-faq)
-  - [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key)
  - [⭐️ Use the latest and specific release](#%EF%B8%8F-use-the-latest-and-specific-release)
+  - [⭐️ How to add `CNAME`](#%EF%B8%8F-how-to-add-cname)
+  - [⭐️ Deployment completed but you cannot read](#%EF%B8%8F-deployment-completed-but-you-cannot-read)
 - [Examples](#examples)
  - [⭐️ Static Site Generators with Node.js](#%EF%B8%8F-static-site-generators-with-nodejs)
  - [⭐️ Gatsby](#%EF%B8%8F-gatsby)
@@ -96,9 +101,35 @@ Three tokens are supported.

 ## Getting started

-### ⭐️ Repository type - Project
+### (1) Add SSH deploy key

-Add your workflow file `.github/workflows/gh-pages.yml` and push to the remote master branch.
+Generate your deploy key with the following command.
+
+```sh
+ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""
+# You will get 2 files:
+#   gh-pages.pub (public key)
+#   gh-pages     (private key)
+```
+
+Next, Go to **Repository Settings**
+
+- Go to **Deploy Keys** and add your public key with the **Allow write access**
+- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY`
+
+| Add your public key | Success |
+|---|---|
+| ![](./images/deploy-keys-1.jpg) | ![](./images/deploy-keys-2.jpg) |
+
+| Add your private key | Success |
+|---|---|
+| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
+
+### (2) Create your workflow
+
+Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch.
+
+#### ⭐️ Repository type - Project

 An example workflow for Hugo.

@@ -106,6 +137,9 @@ An example workflow for Hugo.

 [![peaceiris/actions-hugo - GitHub](https://gh-card.dev/repos/peaceiris/actions-hugo.svg?fullname)](https://github.com/peaceiris/actions-hugo)

+![peaceiris/actions-hugo latest version](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo)
+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
 ```yaml
 name: github pages

@@ -133,7 +167,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./public
 ```

@@ -147,7 +181,7 @@ The above example is for [Project Pages sites]. (`<username>/<project_name>` rep
 |---|---|
 | ![](./images/log3.jpg) | ![](./images/log4.jpg) |

-### ⭐️ Repository type - User and Organization
+#### ⭐️ Repository type - User and Organization

 For [User and Organization Pages sites] (`<username>/<username>.github.io` repository),
 we have to set `master` branch to `publish_branch`.
@@ -171,7 +205,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./public
          publish_branch: master  # deploying branch
 ```
@@ -190,63 +224,28 @@ jobs:

 ## Options

-### ⭐️ `deploy_key`
-
-Read [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH deploy key, and set the `deploy_key` option like the following.
-
-```yaml
- name: Deploy
-  uses: peaceiris/actions-gh-pages@v3
-  with:
-    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-    publish_dir: ./public
-```
-
 ### ⭐️ `personal_token`

 [Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.

-
-```yaml
- name: Deploy
-  uses: peaceiris/actions-gh-pages@v3
-  with:
-    personal_token: ${{ secrets.PERSONAL_TOKEN }}
-    publish_dir: ./public
+```diff
+- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+ personal_token: ${{ secrets.PERSONAL_TOKEN }}
 ```

-### ⭐️ CNAME
+### ⭐️ `github_token`

-To add `CNAME` file, we can set the `cname` option.
+> ⚠️ **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]

-For more details about `CNAME`, read the official documentation: [Managing a custom domain for your GitHub Pages site - GitHub Help](https://help.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site)
+[Issue #9]: https://github.com/peaceiris/actions-gh-pages/issues/9

-```yaml
- name: Deploy
-  uses: peaceiris/actions-gh-pages@v3
-  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
-    publish_dir: ./public
-    cname: github.com
+```diff
+- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+ github_token: ${{ secrets.GITHUB_TOKEN }}
 ```

-### ⭐️ Disable `.nojekyll`
-
-By default, this action adds the `.nojekyll` file to only the `master` and `gh-pages` branches. When the file already exists, this action does nothing.
-
-To disable this behavior, we can set the `disable_nojekyll` option to `true`.
-
-```yaml
- name: Deploy
-  uses: peaceiris/actions-gh-pages@v3
-  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
-    publish_dir: ./public
-    disable_nojekyll: true
-```
-
-For more details about `.nojekyll`: [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
-
 ### ⭐️ Allow empty commits

 By default, a commit will not be generated when no file changes. If you want to allow an empty commit, set the optional parameter `allow_empty_commit` to `true`.
@@ -257,7 +256,7 @@ For example:
 - name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    publish_dir: ./public
    allow_empty_commit: true
 ```
@@ -272,7 +271,7 @@ For example:
 - name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    publish_dir: ./public
    keep_files: true
 ```
@@ -290,7 +289,7 @@ For example:
  with:
    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    external_repository: username/external-repository
-    publish_branch: master
+    publish_branch: gh-pages
    publish_dir: ./public
 ```

@@ -308,7 +307,7 @@ This allows you to make your publish branch with only the latest commit.
 - name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    publish_dir: ./public
    force_orphan: true
 ```
@@ -322,7 +321,7 @@ A commit is always created with the same user.
 - name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    publish_dir: ./public
    user_name: iris
    user_email: iris@peaceiris.com
@@ -337,7 +336,7 @@ When we create a commit with a message `docs: Update some post`, a deployment co
 - name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    publish_dir: ./public
    commit_message: ${{ github.event.head_commit.message }}
 ```
@@ -375,7 +374,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          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 }}'
@@ -403,30 +402,6 @@ v1.2.3         # Tag on the master branch

 ## Tips and FAQ

-### ⭐️ Create SSH Deploy Key
-
-Generate your deploy key with the following command.
-
-```sh
-ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""
-# You will get 2 files:
-#   gh-pages.pub (public key)
-#   gh-pages     (private key)
-```
-
-Next, Go to **Repository Settings**
-
- Go to **Deploy Keys** and add your public key with the **Allow write access**
- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY`
-
-| Add your public key | Success |
-|---|---|
-| ![](./images/deploy-keys-1.jpg) | ![](./images/deploy-keys-2.jpg) |
-
-| Add your private key | Success |
-|---|---|
-| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
-
 ### ⭐️ Use the latest and specific release

 We recommend you to use the latest and specific release of this action for stable CI/CD.
@@ -434,6 +409,47 @@ It is useful to watch this repository (release only) to check the [latest releas

 [latest release]: https://github.com/peaceiris/actions-gh-pages/releases

+### ⭐️ How to add `CNAME`
+
+Most of the Static Site Generators support `CNAME` as a static file.
+
+- [Use a Custom Domain | Hugo](https://gohugo.io/hosting-and-deployment/hosting-on-github/#use-a-custom-domain)
+- [Using the Static folder | GatsbyJS](https://www.gatsbyjs.org/docs/static-folder/)
+
+The same may be said of other files (`.nojekyll`, `BingSiteAuth.xml`, `robots.txt`, etc.). It is better to manage those files by Static Site Generators.
+
+Does not your static site generator deal with the static files? No problem, you can add the file like the following.
+
+```yaml
+- name: Build
+  run: |
+    buildcommand
+    cp ./path/to/CNAME ./public/CNAME
+
+- name: Deploy
+```
+
+### ⭐️ Deployment completed but you cannot read
+
+Does your `publish_dir` contain files or directories that name starts with an underscore? (`_modules`, `_sources` and `_next`, etc.)
+GitHub Pages does not read those by default.
+Please add `.nojekyll` file to `publish_dir`.
+
+- [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
+
+> It is now possible to completely bypass Jekyll processing on GitHub Pages by creating a file named `.nojekyll` in the root of your pages repo and pushing it to GitHub. This should only be necessary if your site uses files or directories that start with underscores since Jekyll considers these to be special resources and does not copy them to the final site.
+
+Does not your static site generator deal with the static files? No problem, you can add the file like the following.
+
+```yaml
+- name: Build
+  run: |
+    buildcommand
+    touch ./public/.nojekyll
+
+- name: Deploy
+```
+
 <div align="right">
 <a href="#table-of-contents">Back to TOC ☝️</a>
 </div>
@@ -454,6 +470,8 @@ It is useful to watch this repository (release only) to check the [latest releas

 Premise: Dependencies are managed by `package.json` and `package-lock.json`

+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
 ```yaml
 name: github pages

@@ -482,12 +500,13 @@ jobs:
            ${{ runner.os }}-node-

      - run: npm ci
+
      - run: npm run build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./public
 ```

@@ -498,6 +517,8 @@ An example for [Gatsby] (Gatsby.js) project with [gatsby-starter-blog]
 [Gatsby]: https://github.com/gatsbyjs/gatsby
 [gatsby-starter-blog]: https://github.com/gatsbyjs/gatsby-starter-blog

+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
 ```yaml
 name: github pages

@@ -526,14 +547,17 @@ jobs:
            ${{ runner.os }}-node-

      - run: npm ci
+
      - run: npm run format
+
      - run: npm run test
+
      - run: npm run build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./public
 ```

@@ -546,6 +570,8 @@ An example for [Next.js] (React.js) project with [create-next-app]
 [Next.js]: https://github.com/zeit/next.js
 [create-next-app]: https://nextjs.org/docs

+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
 ```yaml
 name: github pages

@@ -578,13 +604,17 @@ jobs:
            ${{ runner.os }}-yarn-

      - run: yarn install
+
      - run: yarn build
+
      - run: yarn export

+      - run: touch ./out/.nojekyll
+
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./out
 ```

@@ -597,6 +627,8 @@ An example for [Nuxt.js] (Vue.js) project with [create-nuxt-app]
 [Nuxt.js]: https://github.com/nuxt/nuxt.js
 [create-nuxt-app]: https://github.com/nuxt/create-nuxt-app

+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
 ```yaml
 name: github pages

@@ -625,13 +657,15 @@ jobs:
            ${{ runner.os }}-node-

      - run: npm ci
+
      - run: npm test
+
      - run: npm run generate

      - name: deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./dist
 ```

@@ -645,6 +679,8 @@ jobs:

 Premise: Dependencies are managed by `requirements.txt`

+![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
+
 ```yaml
 name: github pages

@@ -683,7 +719,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./site
 ```

@@ -720,7 +756,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./book
 ```

@@ -766,7 +802,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./build/web
 ```

@@ -807,7 +843,7 @@ jobs:
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./public
 ```

--- a/tests/utils.test.ts
+++ b/tests/utils.test.ts
@@ -16,12 +16,6 @@ beforeEach(() => {

 // });

-async function getTime(): Promise<string> {
-  const date = new Date();
-  const unixTime = date.getTime();
-  return `${unixTime}`;
-}
-
 describe('getHomeDir()', () => {
  test('get home directory name', async () => {
    let test = '';
@@ -30,38 +24,14 @@ describe('getHomeDir()', () => {
    } else {
      test = `${process.env.HOME}`;
    }
-    const expected = await getHomeDir();
-    expect(test).toMatch(expected);
-  });
-});
-
-describe('getWorkDirName()', () => {
-  test('get work directory name', async () => {
-    let home = '';
-    if (process.platform === 'win32') {
-      home = 'C:\\Users\\runneradmin';
-    } else {
-      home = `${process.env.HOME}`;
-    }
-    const unixTime = await getTime();
-    const expected = path.join(home, `actions_github_pages_${unixTime}`);
-    const test = await getWorkDirName(`${unixTime}`);
-    expect(test).toMatch(expected);
-  });
-});
-
-describe('createWorkDir()', () => {
-  test('create work directory', async () => {
-    const unixTime = await getTime();
-    const workDirName = await getWorkDirName(`${unixTime}`);
-    await createWorkDir(workDirName);
-    const test = fs.existsSync(workDirName);
-    expect(test).toBe(true);
+    const homeDir = await getHomeDir();
+    expect(homeDir).toMatch(test);
  });
 });

 async function getWorkDir(): Promise<string> {
-  const unixTime = await getTime();
+  const date = new Date();
+  const unixTime = date.getTime();
  let workDir = '';
  workDir = await getWorkDirName(`${unixTime}`);
  await createWorkDir(workDir);
--- a/lib/index.js
+++ b/lib/index.js
@@ -2746,7 +2746,7 @@ function addCNAME(workDir, content) {
        }
        const filepath = path_1.default.join(workDir, 'CNAME');
        if (fs_1.default.existsSync(filepath)) {
-            core.warning(`CNAME already exists, skip adding CNAME`);
+            core.warning(`CNAME already exists`);
            return;
        }
        fs_1.default.writeFileSync(filepath, content + '\n');
@@ -7954,6 +7954,9 @@ exports.RequestError = RequestError;

 "use strict";

+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
@@ -7964,13 +7967,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/master/src/github.ts
 const graphql_1 = __webpack_require__(898);
-const rest_1 = __webpack_require__(0);
+const rest_1 = __importDefault(__webpack_require__(0));
 const Context = __importStar(__webpack_require__(262));
 const httpClient = __importStar(__webpack_require__(539));
 // We need this in order to extend Octokit
-rest_1.Octokit.prototype = new rest_1.Octokit();
+rest_1.default.prototype = new rest_1.default();
 exports.context = new Context.Context();
-class GitHub extends rest_1.Octokit {
+class GitHub extends rest_1.default {
    constructor(token, opts) {
        super(GitHub.getOctokitOptions(GitHub.disambiguate(token, opts)));
        this.graphql = GitHub.getGraphQL(GitHub.disambiguate(token, opts));
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
 {
  "name": "actions-github-pages",
-  "version": "3.4.0",
+  "version": "3.3.0-0",
  "lockfileVersion": 1,
  "requires": true,
  "dependencies": {
@@ -18,13 +18,13 @@
      }
    },
    "@actions/github": {
-      "version": "2.1.1",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-2.1.1.tgz",
-      "integrity": "sha512-kAgTGUx7yf5KQCndVeHSwCNZuDBvPyxm5xKTswW2lofugeuC1AZX73nUUVDNaysnM9aKFMHv9YCdVJbg7syEyA==",
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-2.1.0.tgz",
+      "integrity": "sha512-G4ncMlh4pLLAvNgHUYUtpWQ1zPf/VYqmRH9oshxLabdaOOnp7i1hgSgzr2xne2YUaSND3uqemd3YYTIsm2f/KQ==",
      "requires": {
        "@actions/http-client": "^1.0.3",
        "@octokit/graphql": "^4.3.1",
-        "@octokit/rest": "^16.43.1"
+        "@octokit/rest": "^16.15.0"
      }
    },
    "@actions/http-client": {
@@ -756,9 +756,9 @@
      "dev": true
    },
    "@types/node": {
-      "version": "12.12.28",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.28.tgz",
-      "integrity": "sha512-g73GJYJDXgf0jqg+P9S8h2acWbDXNkoCX8DLtJVu7Fkn788pzQ/oJsrdJz/2JejRf/SjfZaAhsw+3nd1D5EWGg=="
+      "version": "12.12.27",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.27.tgz",
+      "integrity": "sha512-odQFl/+B9idbdS0e8IxDl2ia/LP8KZLXhV3BUeI98TrZp0uoIzQPhGd+5EtzHmT0SMOIaPd7jfz6pOHLWTtl7A=="
    },
    "@types/parse-json": {
      "version": "4.0.0",
@@ -835,13 +835,13 @@
      }
    },
    "@typescript-eslint/experimental-utils": {
-      "version": "2.20.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-2.20.0.tgz",
-      "integrity": "sha512-fEBy9xYrwG9hfBLFEwGW2lKwDRTmYzH3DwTmYbT+SMycmxAoPl0eGretnBFj/s+NfYBG63w/5c3lsvqqz5mYag==",
+      "version": "2.19.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-2.19.0.tgz",
+      "integrity": "sha512-zwpg6zEOPbhB3+GaQfufzlMUOO6GXCNZq6skk+b2ZkZAIoBhVoanWK255BS1g5x9bMwHpLhX0Rpn5Fc3NdCZdg==",
      "dev": true,
      "requires": {
        "@types/json-schema": "^7.0.3",
-        "@typescript-eslint/typescript-estree": "2.20.0",
+        "@typescript-eslint/typescript-estree": "2.19.0",
        "eslint-scope": "^5.0.0"
      }
    },
@@ -892,9 +892,9 @@
      }
    },
    "@typescript-eslint/typescript-estree": {
-      "version": "2.20.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-2.20.0.tgz",
-      "integrity": "sha512-WlFk8QtI8pPaE7JGQGxU7nGcnk1ccKAJkhbVookv94ZcAef3m6oCE/jEDL6dGte3JcD7reKrA0o55XhBRiVT3A==",
+      "version": "2.19.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-2.19.0.tgz",
+      "integrity": "sha512-n6/Xa37k0jQdwpUszffi19AlNbVCR0sdvCs3DmSKMD7wBttKY31lhD2fug5kMD91B2qW4mQldaTEc1PEzvGu8w==",
      "dev": true,
      "requires": {
        "debug": "^4.1.1",
@@ -915,9 +915,9 @@
      }
    },
    "@zeit/ncc": {
-      "version": "0.21.1",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.1.tgz",
-      "integrity": "sha512-M9WzgquSOt2nsjRkYM9LRylBLmmlwNCwYbm3Up3PDEshfvdmIfqpFNSK8EJvR18NwZjGHE5z2avlDtYQx2JQnw==",
+      "version": "0.21.0",
+      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.0.tgz",
+      "integrity": "sha512-RUMdvVK/w78oo+yBjruZltt0kJXYar2un/1bYQ2LuHG7GmFVm+QjxzEmySwREctaJdEnBvlMdUNWd9hXHxEI3g==",
      "dev": true
    },
    "JSONStream": {
@@ -2385,9 +2385,9 @@
      }
    },
    "eslint-plugin-jest": {
-      "version": "23.8.0",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-23.8.0.tgz",
-      "integrity": "sha512-DKXmLxguZ1Lru4u5YM12ko3WLq6gqo7dhV2b63K731+/PNyZ/Ff6NGONQsGUtPLG9zU3kdz/N+2LTbweNZifeg==",
+      "version": "23.7.0",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-23.7.0.tgz",
+      "integrity": "sha512-zkiyGlvJeHNjAEz8FaIxTXNblJJ/zj3waNbYbgflK7K6uy0cpE5zJBt/JpJtOBGM/UGkC6BqsQ4n0y7kQ2HA8w==",
      "dev": true,
      "requires": {
        "@typescript-eslint/experimental-utils": "^2.5.0"
@@ -7507,9 +7507,9 @@
      }
    },
    "typescript": {
-      "version": "3.8.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.8.2.tgz",
-      "integrity": "sha512-EgOVgL/4xfVrCMbhYKUQTdF37SQn4Iw73H5BgCrF1Abdun7Kwy/QZsE/ssAy0y4LxBbvua3PIbFsbRczWWnDdQ==",
+      "version": "3.7.5",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.5.tgz",
+      "integrity": "sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==",
      "dev": true
    },
    "uglify-js": {
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "actions-github-pages",
-  "version": "3.4.0",
+  "version": "3.3.0-0",
  "description": "GitHub Actions for GitHub Pages",
  "main": "lib/index.js",
  "engines": {
@@ -52,7 +52,7 @@
  "dependencies": {
    "@actions/core": "^1.2.2",
    "@actions/exec": "^1.0.3",
-    "@actions/github": "^2.1.1",
+    "@actions/github": "^2.1.0",
    "@actions/io": "^1.0.2"
  },
  "devDependencies": {
@@ -60,9 +60,9 @@
    "@types/node": "~12",
    "@typescript-eslint/eslint-plugin": "^2.20.0",
    "@typescript-eslint/parser": "^2.20.0",
-    "@zeit/ncc": "^0.21.1",
+    "@zeit/ncc": "^0.21.0",
    "eslint": "^6.8.0",
-    "eslint-plugin-jest": "^23.8.0",
+    "eslint-plugin-jest": "^23.7.0",
    "husky": "^4.2.3",
    "jest": "^25.1.0",
    "jest-circus": "^25.1.0",
@@ -70,6 +70,6 @@
    "prettier": "1.19.1",
    "standard-version": "^7.1.0",
    "ts-jest": "^25.2.1",
-    "typescript": "^3.8.2"
+    "typescript": "^3.7.5"
  }
 }
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -56,7 +56,7 @@ export async function addCNAME(
  }
  const filepath = path.join(workDir, 'CNAME');
  if (fs.existsSync(filepath)) {
-    core.warning(`CNAME already exists, skip adding CNAME`);
+    core.warning(`CNAME already exists`);
    return;
  }
  fs.writeFileSync(filepath, content + '\n');
Author	SHA1	Message	Date
peaceiris	85405d4dd5	chore(release): 3.3.0-0 Some checks failed Release / release (push) Has been cancelled Details	2020-02-21 01:34:32 +09:00
peaceiris	d85d214cc6	chore(release): Add build assets	2020-02-21 01:34:31 +09:00
peaceiris	b9a6975827	chore: Add vim	2020-02-21 01:27:06 +09:00
peaceiris	7c4b591cf6	feat: Add disable_nojekyll and cname options - Add .nojekyll file by default for only the master and gh-pages branches. When the file already exists, this action does nothing. - When we set other branches to publish_dir, this action does not add .nojekyll file. cf. #112 Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com> Co-authored-by: Nicolas Vanhoren <nicolas.vanhoren@gmail.com>	2020-02-20 16:10:11 +00:00