chore(release): 3.7.0-1

Related to #324

.github/dependabot.yml

@@ -21,6 +21,6 @@ updates:
   schedule:
     interval: "daily"
   labels:
-  - "dependencies:ci"
+  - "CI/CD"
   commit-message:
     prefix: ci

.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:
@@ -64,7 +64,7 @@ jobs:
           name: coverage-${{ matrix.os }}
           path: coverage
 
-      - uses: codecov/codecov-action@v1.0.10
+      - uses: codecov/codecov-action@v1.0.11
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
@@ -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,65 @@
 
 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.7.0-1](https://github.com/peaceiris/actions-gh-pages/compare/v3.7.0-0...v3.7.0-1) (2020-07-21)
+
+
+### docs
+
+* Enhance section name ([3874723](https://github.com/peaceiris/actions-gh-pages/commit/3874723ac6158d13e3f1e3c8fd34e1ce96d9edf7))
+
+### fix
+
+* KeepFiles behaviour when DestinationDir has dir (#405) ([ce4e3be](https://github.com/peaceiris/actions-gh-pages/commit/ce4e3beff1ed33658f3160b0f45b688c6ea09932)), closes [#405](https://github.com/peaceiris/actions-gh-pages/issues/405) [#324](https://github.com/peaceiris/actions-gh-pages/issues/324)
+
+
+
+# [3.7.0-0](https://github.com/peaceiris/actions-gh-pages/compare/v3.6.4...v3.7.0-0) (2020-07-21)
+
+
+### ci
+
+* bump codecov/codecov-action from v1.0.10 to v1.0.11 (#401) ([a5a8912](https://github.com/peaceiris/actions-gh-pages/commit/a5a8912d3e47a3ba8785d356ebed0fd02e2eeb46)), closes [#401](https://github.com/peaceiris/actions-gh-pages/issues/401)
+* update label ([5980f05](https://github.com/peaceiris/actions-gh-pages/commit/5980f05de835c05638459c3c7a80d76edd0c7969))
+
+### deps
+
+* bump @types/jest from 26.0.4 to 26.0.5 (#402) ([42a6cdd](https://github.com/peaceiris/actions-gh-pages/commit/42a6cdde0c0d499af05cd22020132f6240d578a8)), closes [#402](https://github.com/peaceiris/actions-gh-pages/issues/402)
+* bump @types/node from 12.12.50 to 12.12.51 (#404) ([0cb61e9](https://github.com/peaceiris/actions-gh-pages/commit/0cb61e91a5487c04cb202e13a8d2bc25c09c80e1)), closes [#404](https://github.com/peaceiris/actions-gh-pages/issues/404)
+
+### docs
+
+* update dependabot label ([2504696](https://github.com/peaceiris/actions-gh-pages/commit/250469649c036a88f547b96f94867900a1f19163))
+
+### feat
+
+* Add destination_dir option (#403) ([f30118c](https://github.com/peaceiris/actions-gh-pages/commit/f30118c78eebbbe6cf66009b80a7414a4047de43)), closes [#403](https://github.com/peaceiris/actions-gh-pages/issues/403) [#324](https://github.com/peaceiris/actions-gh-pages/issues/324) [#390](https://github.com/peaceiris/actions-gh-pages/issues/390)
+
+
+
+## [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)
 
 

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">
@@ -69,17 +69,18 @@ All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
   - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
   - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
 - [Options](#options)
-  - [⭐️ `github_token`](#%EF%B8%8F-github_token)
-  - [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
-  - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
-  - [⭐️ `publish_branch`](#%EF%B8%8F-publish_branch)
-  - [⭐️ `publish_dir`](#%EF%B8%8F-publish_dir)
-  - [⭐️ CNAME](#%EF%B8%8F-cname)
-  - [⭐️ Enable Built-in Jekyll](#%EF%B8%8F-enable-built-in-jekyll)
-  - [⭐️ Allow empty commits](#%EF%B8%8F-allow-empty-commits)
-  - [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
-  - [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
-  - [⭐️ Force orphan](#%EF%B8%8F-force-orphan)
+  - [⭐️ Set Runner's Access Token `github_token`](#%EF%B8%8F-set-runners-access-token-github_token)
+  - [⭐️ Set SSH Private Key `deploy_key`](#%EF%B8%8F-set-ssh-private-key-deploy_key)
+  - [⭐️ Set Personal Access Token `personal_token`](#%EF%B8%8F-set-personal-access-token-personal_token)
+  - [⭐️ Target Branch `publish_branch`](#%EF%B8%8F-target-branch-publish_branch)
+  - [⭐️ Source Directory `publish_dir`](#%EF%B8%8F-source-directory-publish_dir)
+  - [⭐️ Deploy to Subdirectory `destination_dir`](#%EF%B8%8F-deploy-to-subdirectory-destination_dir)
+  - [⭐️ Add CNAME file `cname`](#%EF%B8%8F-add-cname-file-cname)
+  - [⭐️ Enable Built-in Jekyll `enable_jekyll`](#%EF%B8%8F-enable-built-in-jekyll-enable_jekyll)
+  - [⭐️ Allow empty commits `allow_empty_commit`](#%EF%B8%8F-allow-empty-commits-allow_empty_commit)
+  - [⭐️ Keeping existing files `keep_files`](#%EF%B8%8F-keeping-existing-files-keep_files)
+  - [⭐️ Deploy to external repository `external_repository`](#%EF%B8%8F-deploy-to-external-repository-external_repository)
+  - [⭐️ Force orphan `force_orphan`](#%EF%B8%8F-force-orphan-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)
@@ -200,7 +201,7 @@ jobs:
 
 ## Options
 
-### ⭐️ `github_token`
+### ⭐️ Set Runner's Access Token `github_token`
 
 **This option is for `GITHUB_TOKEN`, not a personal access token.**
 
@@ -216,7 +217,7 @@ GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in yo
 
 For more details about `GITHUB_TOKEN`: [Authenticating with the GITHUB_TOKEN - GitHub Help](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
 
-### ⭐️ `deploy_key`
+### ⭐️ Set SSH Private Key `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.
 
@@ -228,11 +229,10 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
     publish_dir: ./public
 ```
 
-### ⭐️ `personal_token`
+### ⭐️ Set Personal Access 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`.
 
-
 ```yaml
 - name: Deploy
   uses: peaceiris/actions-gh-pages@v3
@@ -241,7 +241,7 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
     publish_dir: ./public
 ```
 
-### ⭐️ `publish_branch`
+### ⭐️ Target Branch `publish_branch`
 
 A target branch to deploy to GitHub Pages. The default is `gh-pages`.
 
@@ -253,9 +253,9 @@ A target branch to deploy to GitHub Pages. The default is `gh-pages`.
     publish_branch: master  # default: gh-pages
 ```
 
-### ⭐️ `publish_dir`
+### ⭐️ Source Directory `publish_dir`
 
-A target directory to deploy to GitHub Pages. The default is `public`.
+A source directory to deploy to GitHub Pages. The default is `public`.
 
 ```yaml
 - name: Deploy
@@ -265,7 +265,22 @@ A target directory to deploy to GitHub Pages. The default is `public`.
     publish_dir: ./out  # default: public
 ```
 
-### ⭐️ CNAME
+### ⭐️ Deploy to Subdirectory `destination_dir`
+
+*This feature is on beta.*
+*Any feedback is welcome at [Issue #324](https://github.com/peaceiris/actions-gh-pages/issues/324)*
+
+A destination subdirectory on a publishing branch. The default is empty.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3.7.0-0
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    destination_dir: subdir
+```
+
+### ⭐️ Add CNAME file `cname`
 
 To add `CNAME` file, we can set the `cname` option.
 
@@ -280,7 +295,7 @@ For more details about `CNAME`, read the official documentation: [Managing a cus
     cname: github.com
 ```
 
-### ⭐️ Enable Built-in Jekyll
+### ⭐️ Enable Built-in Jekyll `enable_jekyll`
 
 If you want GitHub Pages to process your site with the static site generator Jekyll, set `enable_jekyll` to true.
 
@@ -302,7 +317,7 @@ Bypassing Jekyll makes the deployment faster and is necessary if you are deployi
 
 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
+### ⭐️ Allow empty commits `allow_empty_commit`
 
 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`.
 
@@ -317,7 +332,7 @@ For example:
     allow_empty_commit: true
 ```
 
-### ⭐️ Keeping existing files
+### ⭐️ Keeping existing files `keep_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 `keep_files` to `true`.
 
@@ -332,7 +347,7 @@ For example:
     keep_files: true
 ```
 
-### ⭐️ Deploy to external repository
+### ⭐️ Deploy to external repository `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>`.
@@ -361,7 +376,7 @@ A GitHub Free Plan account cannot use the GitHub Pages in a private repository.
 - `peaceiris/homepage`: A private repository running this action with `external_repository: peaceiris/peaceiris.github.io`
 - `peaceiris/peaceiris.github.io`: A public repository using GitHub Pages
 
-### ⭐️ Force orphan
+### ⭐️ Force orphan `force_orphan`
 
 We can set the `force_orphan: true` option.
 This allows you to make your publish branch with only the latest commit.
@@ -535,7 +550,7 @@ updates:
   schedule:
     interval: "daily"
   labels:
-  - "dependencies:ci"
+  - "CI/CD"
   commit-message:
     prefix: ci
 ```
@@ -1081,7 +1096,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__/get-inputs.test.ts

@@ -40,6 +40,7 @@ function getInputsLog(authMethod: string, inps: Inputs): string {
 [INFO] ${authMethod}: true
 [INFO] PublishBranch: ${inps.PublishBranch}
 [INFO] PublishDir: ${inps.PublishDir}
+[INFO] DestinationDir: ${inps.DestinationDir}
 [INFO] ExternalRepository: ${inps.ExternalRepository}
 [INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}
 [INFO] KeepFiles: ${inps.KeepFiles}
@@ -107,6 +108,7 @@ describe('getInputs()', () => {
     expect(inps.PersonalToken).toMatch('');
     expect(inps.PublishBranch).toMatch('gh-pages');
     expect(inps.PublishDir).toMatch('public');
+    expect(inps.DestinationDir).toMatch('');
     expect(inps.ExternalRepository).toMatch('');
     expect(inps.AllowEmptyCommit).toBe(false);
     expect(inps.KeepFiles).toBe(false);
@@ -127,6 +129,7 @@ describe('getInputs()', () => {
     process.env['INPUT_PERSONAL_TOKEN'] = 'test_personal_token';
     process.env['INPUT_PUBLISH_BRANCH'] = 'master';
     process.env['INPUT_PUBLISH_DIR'] = 'out';
+    process.env['INPUT_DESTINATION_DIR'] = 'subdir';
     process.env['INPUT_EXTERNAL_REPOSITORY'] = 'user/repo';
     process.env['INPUT_ALLOW_EMPTY_COMMIT'] = 'true';
     process.env['INPUT_KEEP_FILES'] = 'true';
@@ -147,6 +150,7 @@ describe('getInputs()', () => {
     expect(inps.PersonalToken).toMatch('test_personal_token');
     expect(inps.PublishBranch).toMatch('master');
     expect(inps.PublishDir).toMatch('out');
+    expect(inps.DestinationDir).toMatch('subdir');
     expect(inps.ExternalRepository).toMatch('user/repo');
     expect(inps.AllowEmptyCommit).toBe(true);
     expect(inps.KeepFiles).toBe(true);

__tests__/git-utils.test.ts

@@ -1,5 +1,13 @@
-import {getUserName, getUserEmail, setCommitAuthor, getCommitMessage} from '../src/git-utils';
-import {getWorkDirName, createWorkDir} from '../src/utils';
+import {
+  setRepo,
+  getUserName,
+  getUserEmail,
+  setCommitAuthor,
+  getCommitMessage
+} from '../src/git-utils';
+import {getInputs} from '../src/get-inputs';
+import {Inputs} from '../src/interfaces';
+import {getWorkDirName, createDir} from '../src/utils';
 import {CmdResult} from '../src/interfaces';
 import * as exec from '@actions/exec';
 
@@ -14,6 +22,35 @@ afterEach(() => {
   delete process.env['GITHUB_REPOSITORY'];
 });
 
+describe('setRepo()', () => {
+  test('throw error destination_dir should be a relative path', async () => {
+    process.env['INPUT_GITHUB_TOKEN'] = 'test_github_token';
+    process.env['INPUT_PUBLISH_BRANCH'] = 'gh-pages';
+    process.env['INPUT_PUBLISH_DIR'] = 'public';
+    process.env['INPUT_DESTINATION_DIR'] = '/subdir';
+    // process.env['INPUT_EXTERNAL_REPOSITORY'] = 'user/repo';
+    // process.env['INPUT_ALLOW_EMPTY_COMMIT'] = 'true';
+    // process.env['INPUT_KEEP_FILES'] = 'true';
+    // process.env['INPUT_FORCE_ORPHAN'] = 'true';
+    // process.env['INPUT_USER_NAME'] = 'username';
+    // process.env['INPUT_USER_EMAIL'] = 'github@github.com';
+    // process.env['INPUT_COMMIT_MESSAGE'] = 'feat: Add new feature';
+    // process.env['INPUT_FULL_COMMIT_MESSAGE'] = 'feat: Add new feature';
+    // process.env['INPUT_TAG_NAME'] = 'deploy-v1.2.3';
+    // process.env['INPUT_TAG_MESSAGE'] = 'Deployment v1.2.3';
+    // process.env['INPUT_DISABLE_NOJEKYLL'] = 'true';
+    // process.env['INPUT_CNAME'] = 'github.com';
+    const inps: Inputs = getInputs();
+    const remoteURL = 'https://x-access-token:pat@github.com/actions/pages.git';
+    const date = new Date();
+    const unixTime = date.getTime();
+    const workDir = await getWorkDirName(`${unixTime}`);
+    await expect(setRepo(inps, remoteURL, workDir)).rejects.toThrowError(
+      'destination_dir should be a relative path'
+    );
+  });
+});
+
 describe('getUserName()', () => {
   test('get default git user name', () => {
     const userName = '';
@@ -51,7 +88,7 @@ describe('setCommitAuthor()', () => {
   })();
 
   beforeEach(async () => {
-    await createWorkDir(workDirName);
+    await createDir(workDirName);
     process.chdir(workDirName);
     await exec.exec('git', ['init']);
   });

__tests__/utils.test.ts

@@ -3,7 +3,7 @@ import fs from 'fs';
 import {
   getHomeDir,
   getWorkDirName,
-  createWorkDir,
+  createDir,
   addNoJekyll,
   addCNAME,
   skipOnFork
@@ -51,11 +51,11 @@ describe('getWorkDirName()', () => {
   });
 });
 
-describe('createWorkDir()', () => {
-  test('create work directory', async () => {
+describe('createDir()', () => {
+  test('create a directory', async () => {
     const unixTime = await getTime();
     const workDirName = await getWorkDirName(`${unixTime}`);
-    await createWorkDir(workDirName);
+    await createDir(workDirName);
     const test = fs.existsSync(workDirName);
     expect(test).toBe(true);
   });
@@ -65,7 +65,7 @@ async function getWorkDir(): Promise<string> {
   const unixTime = await getTime();
   let workDir = '';
   workDir = await getWorkDirName(`${unixTime}`);
-  await createWorkDir(workDir);
+  await createDir(workDir);
   return workDir;
 }
 

action.yml

@@ -25,6 +25,10 @@ inputs:
     description: 'Set an input directory for deployment.'
     required: false
     default: 'public'
+  destination_dir:
+    description: 'Set an destination subdirectory for deployment.'
+    required: false
+    default: ''
   external_repository:
     description: 'Set an external repository (owner/repo).'
     required: false

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "actions-github-pages",
-  "version": "3.6.3",
+  "version": "3.7.0-1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -997,9 +997,9 @@
       }
     },
     "@types/jest": {
-      "version": "26.0.4",
-      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-26.0.4.tgz",
-      "integrity": "sha512-4fQNItvelbNA9+sFgU+fhJo8ZFF+AS4Egk3GWwCW2jFtViukXbnztccafAdLhzE/0EiCogljtQQXP8aQ9J7sFg==",
+      "version": "26.0.5",
+      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-26.0.5.tgz",
+      "integrity": "sha512-heU+7w8snfwfjtcj2H458aTx3m5unIToOJhx75ebHilBiiQ39OIdA18WkG4LP08YKeAoWAGvWg8s+22w/PeJ6w==",
       "dev": true,
       "requires": {
         "jest-diff": "^25.2.1",
@@ -1025,9 +1025,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "12.12.50",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.50.tgz",
-      "integrity": "sha512-5ImO01Fb8YsEOYpV+aeyGYztcYcjGsBvN4D7G5r1ef2cuQOpymjWNQi5V0rKHE6PC2ru3HkoUr/Br2/8GUA84w=="
+      "version": "12.12.51",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.51.tgz",
+      "integrity": "sha512-6ILqt8iNThALrxDv2Q4LyYFQxULQz96HKNIFd4s9QRQaiHINYeUpLqeU/2IU7YMtvipG1fQVAy//vY8/fX1Y9w=="
     },
     "@types/normalize-package-data": {
       "version": "2.4.0",
@@ -8388,9 +8388,9 @@
       "dev": true
     },
     "standard-version": {
-      "version": "8.0.1",
-      "resolved": "https://registry.npmjs.org/standard-version/-/standard-version-8.0.1.tgz",
-      "integrity": "sha512-FLZdjvL2tBdwlctfQeyBf4+dX+SFljwdWfUA0F3wPiU9Rn0+FSuD3I0WXuzC1RmcaWwU5WL3EyV4Aanejc8Pqg==",
+      "version": "8.0.2",
+      "resolved": "https://registry.npmjs.org/standard-version/-/standard-version-8.0.2.tgz",
+      "integrity": "sha512-L8X9KFq2SmVmaeZgUmWHFJMOsEWpjgFAwqic6yIIoveM1kdw1vH4Io03WWxUDjypjGqGU6qUtcJoR8UvOv5w3g==",
       "dev": true,
       "requires": {
         "chalk": "^2.4.2",
@@ -8935,9 +8935,9 @@
       }
     },
     "typescript": {
-      "version": "3.9.6",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.6.tgz",
-      "integrity": "sha512-Pspx3oKAPJtjNwE92YS05HQoY7z2SFyOpHo9MqJor3BXAGNaPUs83CuVp9VISFkSjyRfiTpmKuAYGJB7S7hOxw==",
+      "version": "3.9.7",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.7.tgz",
+      "integrity": "sha512-BLbiRkiBzAwsjut4x/dsibSTB6yWpwT5qWmC2OfuCg3GgVQCSgMs4vEctYPhsaGtd0AeuuHMkjZ2h2WG8MSzRw==",
       "dev": true
     },
     "uglify-js": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "actions-github-pages",
-  "version": "3.6.3",
+  "version": "3.7.0-1",
   "description": "GitHub Actions for GitHub Pages",
   "main": "lib/index.js",
   "engines": {
@@ -60,7 +60,7 @@
     "@actions/io": "^1.0.2"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.4",
+    "@types/jest": "^26.0.5",
     "@types/js-yaml": "^3.12.4",
     "@types/node": "~12",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
@@ -76,8 +76,8 @@
     "js-yaml": "^3.14.0",
     "lint-staged": "^10.2.11",
     "prettier": "2.0.5",
-    "standard-version": "^8.0.1",
+    "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
-  echo "$0: Current branch ${CURRENT_BRANCH} is not master, continue? (y/n)"
+if [ "${CURRENT_BRANCH}" != "${DEFAULT_BRANCH}" ]; then
+  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/get-inputs.ts

@@ -15,6 +15,7 @@ export function showInputs(inps: Inputs): void {
 [INFO] ${authMethod}: true
 [INFO] PublishBranch: ${inps.PublishBranch}
 [INFO] PublishDir: ${inps.PublishDir}
+[INFO] DestinationDir: ${inps.DestinationDir}
 [INFO] ExternalRepository: ${inps.ExternalRepository}
 [INFO] AllowEmptyCommit: ${inps.AllowEmptyCommit}
 [INFO] KeepFiles: ${inps.KeepFiles}
@@ -52,6 +53,7 @@ export function getInputs(): Inputs {
     PersonalToken: core.getInput('personal_token'),
     PublishBranch: core.getInput('publish_branch'),
     PublishDir: core.getInput('publish_dir'),
+    DestinationDir: core.getInput('destination_dir'),
     ExternalRepository: core.getInput('external_repository'),
     AllowEmptyCommit: (core.getInput('allow_empty_commit') || 'false').toUpperCase() === 'TRUE',
     KeepFiles: (core.getInput('keep_files') || 'false').toUpperCase() === 'TRUE',

src/git-utils.ts

@@ -4,7 +4,7 @@ import * as io from '@actions/io';
 import path from 'path';
 import fs from 'fs';
 import {Inputs, CmdResult} from './interfaces';
-import {createWorkDir} from './utils';
+import {createDir} from './utils';
 
 export async function createBranchForce(branch: string): Promise<void> {
   await exec.exec('git', ['init']);
@@ -12,7 +12,7 @@ export async function createBranchForce(branch: string): Promise<void> {
   return;
 }
 
-export async function copyAssets(publishDir: string, workDir: string): Promise<void> {
+export async function copyAssets(publishDir: string, destDir: string): Promise<void> {
   const copyOpts = {recursive: true, force: true};
   const files = fs.readdirSync(publishDir);
   core.debug(`${files}`);
@@ -21,7 +21,7 @@ export async function copyAssets(publishDir: string, workDir: string): Promise<v
       continue;
     }
     const filePath = path.join(publishDir, file);
-    await io.cp(filePath, `${workDir}/`, copyOpts);
+    await io.cp(filePath, `${destDir}/`, copyOpts);
     core.info(`[INFO] copy ${file}`);
   }
 
@@ -29,14 +29,28 @@ 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);
+
+  if (path.isAbsolute(inps.DestinationDir)) {
+    throw new Error('destination_dir should be a relative path');
+  }
+  const destDir = ((): string => {
+    if (inps.DestinationDir === '') {
+      return workDir;
+    } else {
+      return path.join(workDir, inps.DestinationDir);
+    }
+  })();
 
   core.info(`[INFO] ForceOrphan: ${inps.ForceOrphan}`);
   if (inps.ForceOrphan) {
-    await createWorkDir(workDir);
+    await createDir(destDir);
     process.chdir(workDir);
     await createBranchForce(inps.PublishBranch);
-    await copyAssets(publishDir, workDir);
+    process.chdir(destDir);
+    await copyAssets(publishDir, destDir);
     return;
   }
 
@@ -59,14 +73,26 @@ export async function setRepo(inps: Inputs, remoteURL: string, workDir: string):
       options
     );
     if (result.exitcode === 0) {
-      process.chdir(workDir);
-      if (inps.KeepFiles) {
-        core.info('[INFO] Keep existing files');
+      await createDir(destDir);
+      process.chdir(destDir);
+
+      if (inps.DestinationDir !== '') {
+        if (inps.KeepFiles) {
+          core.info('[INFO] Keep existing files');
+        } else {
+          core.info(`[INFO] clean up ${destDir}`);
+          await exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+        }
       } else {
-        await exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+        if (inps.KeepFiles) {
+          core.info('[INFO] Keep existing files');
+        } else {
+          core.info(`[INFO] clean up ${destDir}`);
+          await exec.exec('git', ['rm', '-r', '--ignore-unmatch', '*']);
+        }
       }
 
-      await copyAssets(publishDir, workDir);
+      await copyAssets(publishDir, destDir);
       return;
     } else {
       throw new Error(`Failed to clone remote branch ${inps.PublishBranch}`);
@@ -74,10 +100,10 @@ export async function setRepo(inps: Inputs, remoteURL: string, workDir: string):
   } catch (e) {
     core.info(`[INFO] first deployment, create new branch ${inps.PublishBranch}`);
     core.info(e.message);
-    await createWorkDir(workDir);
+    await createDir(destDir);
     process.chdir(workDir);
     await createBranchForce(inps.PublishBranch);
-    await copyAssets(publishDir, workDir);
+    await copyAssets(publishDir, destDir);
     return;
   }
 }

src/interfaces.ts

@@ -4,6 +4,7 @@ export interface Inputs {
   readonly PersonalToken: string;
   readonly PublishBranch: string;
   readonly PublishDir: string;
+  readonly DestinationDir: string;
   readonly ExternalRepository: string;
   readonly AllowEmptyCommit: boolean;
   readonly KeepFiles: boolean;

src/set-tokens.ts

@@ -85,7 +85,10 @@ Use deploy_key or personal_token.
   if (eventName === 'push') {
     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
+`);
     }
   }
 

src/utils.ts

@@ -23,9 +23,9 @@ export async function getWorkDirName(unixTime: string): Promise<string> {
   return workDirName;
 }
 
-export async function createWorkDir(workDirName: string): Promise<void> {
-  await io.mkdirP(workDirName);
-  core.debug(`Created: ${workDirName}`);
+export async function createDir(dirPath: string): Promise<void> {
+  await io.mkdirP(dirPath);
+  core.debug(`Created directory ${dirPath}`);
   return;
 }