chore(release): 3.6.4

Close #242

.github/workflows/codeql.yml

@@ -3,7 +3,7 @@ name: "Code Scanning"
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 
 jobs:

.github/workflows/dev-image.yml

@@ -3,7 +3,7 @@ name: 'Dev Image CI'
 on:
   push:
     branches:
-      - master
+      - main
     paths:
       - '.github/workflows/dev-image.yml'
       - '.dockerignore'
@@ -40,4 +40,4 @@ jobs:
       - run: make cirun cmd="npm ci"
       - run: make ciall
       - run: make push
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'

.github/workflows/test.yml

@@ -3,7 +3,7 @@ name: 'Test'
 on:
   push:
     branches:
-      - master
+      - main
     paths-ignore:
       - '*.md'
   pull_request:
@@ -72,26 +72,26 @@ jobs:
         run: npm run build
 
       - name: Remove lint-staged husky
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'
         run: |
           npm uninstall lint-staged husky
           git checkout package-lock.json package.json
 
       - name: Setup mdBook
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'
         uses: peaceiris/actions-mdbook@v1.1.12
         with:
           mdbook-version: '0.3.7'
 
       - name: Build site
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'
         working-directory: ./test_projects/mdbook
         run: mdbook build
 
       - name: Deploy
         if: |
           startsWith(matrix.os, 'ubuntu-18.04') &&
-          github.ref == 'refs/heads/master'
+          github.ref == 'refs/heads/main'
         uses: ./
         with:
           # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
@@ -110,7 +110,7 @@ jobs:
       - name: Deploy
         if: |
           startsWith(matrix.os, 'ubuntu-16.04') &&
-          github.ref == 'refs/heads/master'
+          github.ref == 'refs/heads/main'
         uses: ./
         with:
           deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
@@ -128,7 +128,7 @@ jobs:
       - name: Deploy
         if: |
           startsWith(matrix.os, 'macos') &&
-          github.ref == 'refs/heads/master'
+          github.ref == 'refs/heads/main'
         uses: ./
         with:
           deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
@@ -147,7 +147,7 @@ jobs:
       - name: Deploy
         if: |
           startsWith(matrix.os, 'windows') &&
-          github.ref == 'refs/heads/master'
+          github.ref == 'refs/heads/main'
         uses: ./
         with:
           # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
@@ -166,7 +166,7 @@ jobs:
       - name: Deploy
         if: |
           startsWith(matrix.os, 'ubuntu-20.04') &&
-          github.ref == 'refs/heads/master'
+          github.ref == 'refs/heads/main'
         uses: ./
         with:
           # deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}

CHANGELOG.md

@@ -2,6 +2,50 @@
 
 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.4](https://github.com/peaceiris/actions-gh-pages/compare/v3.6.3...v3.6.4) (2020-07-18)
+
+
+### chore
+
+* change default branch from master to main (#396) ([932df18](https://github.com/peaceiris/actions-gh-pages/commit/932df18147b59ce4a998b4caabfcc50f1889c827)), closes [#396](https://github.com/peaceiris/actions-gh-pages/issues/396)
+
+### deps
+
+* bump standard-version from 8.0.1 to 8.0.2 (#395) ([c935046](https://github.com/peaceiris/actions-gh-pages/commit/c935046a93788ca4ea55bb13f438ae77a54a9197)), closes [#395](https://github.com/peaceiris/actions-gh-pages/issues/395)
+* bump typescript from 3.9.6 to 3.9.7 (#399) ([7e92312](https://github.com/peaceiris/actions-gh-pages/commit/7e92312ae46d6a7ad1c55a6ce3d98c66ae1ddda3)), closes [#399](https://github.com/peaceiris/actions-gh-pages/issues/399)
+
+### docs
+
+* change default branch from master to main (#397) ([6901b8e](https://github.com/peaceiris/actions-gh-pages/commit/6901b8e8fcec69a339c4a622b85ec3f66e78f90a)), closes [#397](https://github.com/peaceiris/actions-gh-pages/issues/397)
+
+### feat
+
+* Allow absolute path for publish_dir (#400) ([e193524](https://github.com/peaceiris/actions-gh-pages/commit/e193524bff3509becae7e3ced3114176cc70a5dd)), closes [#400](https://github.com/peaceiris/actions-gh-pages/issues/400) [#242](https://github.com/peaceiris/actions-gh-pages/issues/242)
+* enhance error message (#398) ([3d65640](https://github.com/peaceiris/actions-gh-pages/commit/3d656402e52a96a0c027e4ad98f3ce06da7f8c1b)), closes [#398](https://github.com/peaceiris/actions-gh-pages/issues/398)
+
+
+
+## [3.6.3](https://github.com/peaceiris/actions-gh-pages/compare/v3.6.2...v3.6.3) (2020-07-14)
+
+
+### deps
+
+* bump @types/node from 12.12.48 to 12.12.50 (#392) ([a4205cb](https://github.com/peaceiris/actions-gh-pages/commit/a4205cbdd8cd3a11aee9c47b7f9d99a615b70a21)), closes [#392](https://github.com/peaceiris/actions-gh-pages/issues/392)
+* bump standard-version from 8.0.0 to 8.0.1 (#391) ([6b76e36](https://github.com/peaceiris/actions-gh-pages/commit/6b76e36ab31b40e721fdf587221239d94ca5d141)), closes [#391](https://github.com/peaceiris/actions-gh-pages/issues/391)
+
+### docs
+
+* Add dependabot.yml example (#385) ([a8941b8](https://github.com/peaceiris/actions-gh-pages/commit/a8941b89c6f5476753fcdadcacbfb73206faefb3)), closes [#385](https://github.com/peaceiris/actions-gh-pages/issues/385)
+* add notes #349 (#387) ([488b74c](https://github.com/peaceiris/actions-gh-pages/commit/488b74cc9f861adb4649850096fb9f367363c096)), closes [#349](https://github.com/peaceiris/actions-gh-pages/issues/349) [#387](https://github.com/peaceiris/actions-gh-pages/issues/387)
+* Add Schedule and Manual Deployment (#386) ([16d58be](https://github.com/peaceiris/actions-gh-pages/commit/16d58bea333f07b6141ab6d6f95dca541fde8853)), closes [#386](https://github.com/peaceiris/actions-gh-pages/issues/386)
+* pin actions/setup-node from v2 to v2.1.0 (#389) ([d753ac9](https://github.com/peaceiris/actions-gh-pages/commit/d753ac9b7dd593b0877d35bc997ea8665c73866c)), closes [#389](https://github.com/peaceiris/actions-gh-pages/issues/389) [#388](https://github.com/peaceiris/actions-gh-pages/issues/388)
+
+### fix
+
+* isProhibitedBranch detection (#394) ([f53ab0c](https://github.com/peaceiris/actions-gh-pages/commit/f53ab0c2a5d3f3b2e6524639bae8ca84e454e049)), closes [#394](https://github.com/peaceiris/actions-gh-pages/issues/394)
+
+
+
 ## [3.6.2](https://github.com/peaceiris/actions-gh-pages/compare/v3.6.1...v3.6.2) (2020-07-08)
 
 

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)
+[![license](https://img.shields.io/github/license/peaceiris/actions-gh-pages.svg)](https://github.com/peaceiris/actions-gh-pages/blob/main/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](https://github.com/peaceiris/actions-gh-pages/workflows/Test/badge.svg?branch=master&event=push)
+![Test](https://github.com/peaceiris/actions-gh-pages/workflows/Test/badge.svg?branch=main&event=push)
 [![CodeFactor](https://www.codefactor.io/repository/github/peaceiris/actions-gh-pages/badge)](https://www.codefactor.io/repository/github/peaceiris/actions-gh-pages)
 
 <img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="./images/ogp.svg">
@@ -36,7 +36,12 @@ 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)
+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)
+
+And you may need to push manually for the first deployment on a private repository.
+See [Issue #349](https://github.com/peaceiris/actions-gh-pages/issues/349)
 
 ### Supported Platforms
 
@@ -82,6 +87,7 @@ All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
   - [⭐️ 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)
+  - [⭐️ Schedule and Manual Deployment](#%EF%B8%8F-schedule-and-manual-deployment)
 - [Examples](#examples)
   - [⭐️ Static Site Generators with Node.js](#%EF%B8%8F-static-site-generators-with-nodejs)
   - [⭐️ Gatsby](#%EF%B8%8F-gatsby)
@@ -348,7 +354,7 @@ When you use `deploy_key`, set your private key to the repository which includes
 
 **Note that `GITHUB_TOKEN` has no permission to access to external repositories. Please create a personal access token and set it to `personal_token` like `personal_token: ${{ secrets.PERSONAL_TOKEN }}`.**
 
-Use case: 
+Use case:
 
 A GitHub Free Plan account cannot use the GitHub Pages in a private repository. To make your source contents private and deploy it with the GitHub Pages, you can deploy your site from a private repository to a public repository using this option.
 
@@ -518,6 +524,50 @@ It is useful to watch this repository (release only) to check the [latest releas
 
 [latest release]: https://github.com/peaceiris/actions-gh-pages/releases
 
+For continuous updating, we can use the GitHub native Dependabot.
+Here is an example configuration of the bot. The config file is located in `.github/dependabot.yml`.
+
+```yaml
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "daily"
+  labels:
+  - "dependencies:ci"
+  commit-message:
+    prefix: ci
+```
+
+See the official documentation for more details about the Dependabot: [Keeping your dependencies updated automatically - GitHub Docs](https://docs.github.com/en/github/administering-a-repository/keeping-your-dependencies-updated-automatically)
+
+### ⭐️ Schedule and Manual Deployment
+
+For deploying regularly, we can set the `on.schedule` workflow trigger.
+See [Scheduled events | Events that trigger workflows - GitHub Docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events)
+
+For deploying manually, we can set the `on.workflow_dispatch` workflow trigger.
+See [Manual events `workflow_dispatch` | Events that trigger workflows - GitHub Docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#manual-events)
+
+```yaml
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: "22 22 * * *"
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    ...
+```
+
 <div align="right">
 <a href="#table-of-contents">Back to TOC ☝️</a>
 </div>
@@ -552,7 +602,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.1.0
         with:
           node-version: '12.x'
 
@@ -596,7 +646,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.1.0
         with:
           node-version: '12.x'
 
@@ -644,7 +694,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.1.0
         with:
           node-version: '12.x'
 
@@ -695,7 +745,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.1.0
         with:
           node-version: '12.x'
 
@@ -747,7 +797,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.1.0
         with:
           node-version: '12.x'
 
@@ -929,7 +979,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.1.0
         with:
           node-version: '12.x'
 
@@ -1031,7 +1081,7 @@ jobs:
 
 - [MIT License - peaceiris/actions-gh-pages]
 
-[MIT License - peaceiris/actions-gh-pages]: https://github.com/peaceiris/actions-gh-pages/blob/master/LICENSE
+[MIT License - peaceiris/actions-gh-pages]: https://github.com/peaceiris/actions-gh-pages/blob/main/LICENSE
 
 
 

__tests__/set-tokens.test.ts

@@ -47,6 +47,32 @@ describe('setGithubToken()', () => {
     expect(test).toMatch(expected);
   });
 
+  test('return remote url with GITHUB_TOKEN gh-pages (RegExp)', () => {
+    const expected = 'https://x-access-token:GITHUB_TOKEN@github.com/owner/repo.git';
+    const test = setGithubToken(
+      'GITHUB_TOKEN',
+      'owner/repo',
+      'gh-pages',
+      '',
+      'refs/heads/gh-pages-base',
+      'push'
+    );
+    expect(test).toMatch(expected);
+  });
+
+  test('throw error gh-pages-base to gh-pages-base (RegExp)', () => {
+    expect(() => {
+      setGithubToken(
+        'GITHUB_TOKEN',
+        'owner/repo',
+        'gh-pages-base',
+        '',
+        'refs/heads/gh-pages-base',
+        'push'
+      );
+    }).toThrowError('You deploy from gh-pages-base to gh-pages-base');
+  });
+
   test('throw error master to master', () => {
     expect(() => {
       setGithubToken('GITHUB_TOKEN', 'owner/repo', 'master', '', 'refs/heads/master', 'push');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "actions-github-pages",
-  "version": "3.6.2",
+  "version": "3.6.4",
   "description": "GitHub Actions for GitHub Pages",
   "main": "lib/index.js",
   "engines": {
@@ -76,8 +76,8 @@
     "js-yaml": "^3.14.0",
     "lint-staged": "^10.2.11",
     "prettier": "2.0.5",
-    "standard-version": "^8.0.0",
+    "standard-version": "^8.0.2",
     "ts-jest": "^25.5.1",
-    "typescript": "^3.9.6"
+    "typescript": "^3.9.7"
   }
 }

release.sh

@@ -3,9 +3,11 @@
 # fail on unset variables and command errors
 set -eu -o pipefail # -x: is for debugging
 
+DEFAULT_BRANCH="main"
+
 CURRENT_BRANCH="$(git branch --show-current)"
-if [ "${CURRENT_BRANCH}" != "master" ]; then
+if [ "${CURRENT_BRANCH}" != "${DEFAULT_BRANCH}" ]; then
-  echo "$0: Current branch ${CURRENT_BRANCH} is not master, continue? (y/n)"
+  echo "$0: Current branch ${CURRENT_BRANCH} is not ${DEFAULT_BRANCH}, continue? (y/n)"
   read -r res
   if [ "${res}" = "n" ]; then
     echo "$0: Stop script"
@@ -14,7 +16,7 @@ if [ "${CURRENT_BRANCH}" != "master" ]; then
 fi
 
 PRERELEASE_TYPE_LIST="prerelease prepatch preminor premajor"
-if [ "${CURRENT_BRANCH}" != "master" ]; then
+if [ "${CURRENT_BRANCH}" != "${DEFAULT_BRANCH}" ]; then
   RELEASE_TYPE_LIST="${PRERELEASE_TYPE_LIST}"
 else
   RELEASE_TYPE_LIST="${PRERELEASE_TYPE_LIST} patch minor major"
@@ -37,10 +39,10 @@ if [ "${res}" = "n" ]; then
 fi
 
 git fetch origin
-if [ "${CURRENT_BRANCH}" != "master" ]; then
+if [ "${CURRENT_BRANCH}" != "${DEFAULT_BRANCH}" ]; then
   git pull origin "${CURRENT_BRANCH}"
 else
-  git pull origin master
+  git pull origin ${DEFAULT_BRANCH}
   git tag -d v3 || true
   git pull origin --tags
 fi
@@ -58,10 +60,10 @@ git rm ./lib/index.js
 rm -rf ./lib
 git commit -m "chore(release): Remove build assets [skip ci]"
 
-if [ "${CURRENT_BRANCH}" != "master" ]; then
+if [ "${CURRENT_BRANCH}" != "${DEFAULT_BRANCH}" ]; then
   git push origin "${CURRENT_BRANCH}"
 else
-  git push origin master
+  git push origin ${DEFAULT_BRANCH}
 fi
 
 TAG_NAME="v$(jq -r '.version' ./package.json)"

src/git-utils.ts

@@ -29,7 +29,9 @@ export async function copyAssets(publishDir: string, workDir: string): Promise<v
 }
 
 export async function setRepo(inps: Inputs, remoteURL: string, workDir: string): Promise<void> {
-  const publishDir = path.join(`${process.env.GITHUB_WORKSPACE}`, inps.PublishDir);
+  const publishDir = path.isAbsolute(inps.PublishDir)
+    ? inps.PublishDir
+    : path.join(`${process.env.GITHUB_WORKSPACE}`, inps.PublishDir);
 
   core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
   if (inps.ForceOrphan) {

src/set-tokens.ts

@@ -83,9 +83,12 @@ Use deploy_key or personal_token.
   }
 
   if (eventName === 'push') {
-    isProhibitedBranch = ref.includes(`refs/heads/${publishBranch}`);
+    isProhibitedBranch = ref.match(new RegExp(`^refs/heads/${publishBranch}$`)) !== null;
     if (isProhibitedBranch) {
-      throw new Error(`You deploy from ${publishBranch} to ${publishBranch}`);
+      throw new Error(`\
+You deploy from ${publishBranch} to ${publishBranch}
+This operation is prohibited to protect your contents
+`);
     }
   }