feat: Add disable_nojekyll and cname options (#119)

* feat: Add disable_nojekyll and cname options
* docs: Add cname and disable_nojekyll
* chore: Add vim
* chore(release): 3.3.0-0
* ci: Add codecov/codecov-action
* refactor: Enhance warning message

- Add .nojekyll file by default to only the master and gh-pages branches. When the file already exists, this action does nothing.
- When we set other branches to publish_branch, this action does not add .nojekyll file.

cf. https://github.com/peaceiris/actions-gh-pages/issues/112#issuecomment-589678269

Close #112

Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Nicolas Vanhoren <nicolas.vanhoren@gmail.com>

src/get-inputs.ts

@@ -21,6 +21,8 @@ function showInputs(inps: Inputs): void {
   core.info(`[INFO] CommitMessage: ${inps.CommitMessage}`);
   core.info(`[INFO] TagName: ${inps.TagName}`);
   core.info(`[INFO] TagMessage: ${inps.TagMessage}`);
+  core.info(`[INFO] DisableNoJekyll: ${inps.DisableNoJekyll}`);
+  core.info(`[INFO] CNAME: ${inps.CNAME}`);
 }
 
 export function getInputs(): Inputs {
@@ -41,7 +43,10 @@ export function getInputs(): Inputs {
     UserEmail: core.getInput('user_email'),
     CommitMessage: core.getInput('commit_message'),
     TagName: core.getInput('tag_name'),
-    TagMessage: core.getInput('tag_message')
+    TagMessage: core.getInput('tag_message'),
+    DisableNoJekyll:
+      (core.getInput('disable_nojekyll') || 'false').toUpperCase() === 'TRUE',
+    CNAME: core.getInput('cname')
   };
 
   showInputs(inps);

src/git-utils.ts

@@ -5,13 +5,7 @@ import * as io from '@actions/io';
 import path from 'path';
 import fs from 'fs';
 import {Inputs, CmdResult} from './interfaces';
-import {getHomeDir} from './utils';
-
-export async function createWorkDir(workDirName: string): Promise<void> {
-  await io.mkdirP(workDirName);
-  core.debug(`workDir was created: ${workDirName}`);
-  return;
-}
+import {createWorkDir} from './utils';
 
 export async function createBranchForce(branch: string): Promise<void> {
   await exec.exec('git', ['init']);
@@ -41,9 +35,8 @@ export async function copyAssets(
 export async function setRepo(
   inps: Inputs,
   remoteURL: string,
-  unixTime: string
+  workDir: string
 ): Promise<void> {
-  const workDir = path.join(getHomeDir(), `actions_github_pages_${unixTime}`);
   const publishDir = path.join(
     `${process.env.GITHUB_WORKSPACE}`,
     inps.PublishDir

src/interfaces.ts

@@ -13,6 +13,8 @@ export interface Inputs {
   readonly CommitMessage: string;
   readonly TagName: string;
   readonly TagMessage: string;
+  readonly DisableNoJekyll: boolean;
+  readonly CNAME: string;
 }
 
 export interface CmdResult {

src/main.ts

@@ -4,6 +4,7 @@ import {Inputs} from './interfaces';
 import {getInputs} from './get-inputs';
 import {setTokens} from './set-tokens';
 import * as git from './git-utils';
+import {getWorkDirName, addNoJekyll, addCNAME} from './utils';
 
 export async function run(): Promise<void> {
   try {
@@ -16,12 +17,16 @@ export async function run(): Promise<void> {
 
     const date = new Date();
     const unixTime = date.getTime();
-    await git.setRepo(inps, remoteURL, `${unixTime}`);
+    const workDir = await getWorkDirName(`${unixTime}`);
+    await git.setRepo(inps, remoteURL, workDir);
+
+    await addNoJekyll(workDir, inps.DisableNoJekyll, inps.PublishBranch);
+    await addCNAME(workDir, inps.CNAME);
 
     try {
       await exec.exec('git', ['remote', 'rm', 'origin']);
     } catch (e) {
-      core.info(`[INFO] e`);
+      core.info(`[INFO] ${e}`);
     }
     await exec.exec('git', ['remote', 'add', 'origin', remoteURL]);
     await exec.exec('git', ['add', '--all']);

src/set-tokens.ts

@@ -22,7 +22,7 @@ export async function setSSHKey(
 ): Promise<string> {
   core.info('[INFO] setup SSH deploy key');
 
-  const homeDir = getHomeDir();
+  const homeDir = await getHomeDir();
   const sshDir = path.join(homeDir, '.ssh');
   await io.mkdirP(sshDir);
   await exec.exec('chmod', ['700', sshDir]);

src/utils.ts

@@ -1,6 +1,9 @@
 import * as core from '@actions/core';
+import * as io from '@actions/io';
+import path from 'path';
+import fs from 'fs';
 
-export function getHomeDir(): string {
+export async function getHomeDir(): Promise<string> {
   let homedir = '';
 
   if (process.platform === 'win32') {
@@ -13,3 +16,49 @@ export function getHomeDir(): string {
 
   return homedir;
 }
+
+export async function getWorkDirName(unixTime: string): Promise<string> {
+  const homeDir = await getHomeDir();
+  const workDirName = path.join(homeDir, `actions_github_pages_${unixTime}`);
+  return workDirName;
+}
+
+export async function createWorkDir(workDirName: string): Promise<void> {
+  await io.mkdirP(workDirName);
+  core.debug(`Created: ${workDirName}`);
+  return;
+}
+
+export async function addNoJekyll(
+  workDir: string,
+  DisableNoJekyll: boolean,
+  PublishBranch: string
+): Promise<void> {
+  if (DisableNoJekyll) {
+    return;
+  }
+  if (PublishBranch === 'master' || PublishBranch === 'gh-pages') {
+    const filepath = path.join(workDir, '.nojekyll');
+    if (fs.existsSync(filepath)) {
+      return;
+    }
+    fs.closeSync(fs.openSync(filepath, 'w'));
+    core.info(`[INFO] Created ${filepath}`);
+  }
+}
+
+export async function addCNAME(
+  workDir: string,
+  content: string
+): Promise<void> {
+  if (content === '') {
+    return;
+  }
+  const filepath = path.join(workDir, 'CNAME');
+  if (fs.existsSync(filepath)) {
+    core.warning(`CNAME already exists, skip adding CNAME`);
+    return;
+  }
+  fs.writeFileSync(filepath, content + '\n');
+  core.info(`[INFO] Created ${filepath}`);
+}