Merge 6da01c0 into 119ea80

README.md

@@ -50,6 +50,9 @@ Just run [DocToc](https://github.com/thlorenz/doctoc) and commit to branch if ch
 ### TARGET_PATHS
 Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))  
 default: `'README.md'`  
+### TOC_TITLE
+TOC Title.
+default: `'**Table of Contents**'`
 ### COMMIT_MESSAGE
 Commit message.  
 default: `'docs: Update TOC'`  

__tests__/utils/misc.test.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import {getContext, getApiFixture, disableNetConnect, testEnv} from '../util';
+import {getContext, testEnv} from '../util';
 import {
     isTargetEvent,
     getBuildVersion,
@@ -66,15 +66,16 @@ describe('getBuildVersion', () => {
 describe('getDocTocArgs', () => {
     testEnv();
 
-    it('should get default DocToc args', () => {
+    it('should get DocToc args', () => {
         process.env.GITHUB_WORKSPACE = '/tmp/workspace';
-        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md');
+        process.env.INPUT_TARGET_PATHS = 'README.md,.github/CONTRIBUTING.md';
+        process.env.INPUT_TOC_TITLE = '**Table of Contents**';
+        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md /tmp/workspace/.work/.github/CONTRIBUTING.md --title **Table of Contents**');
     });
 
-    it('should get DocToc args', () => {
+    it('should get default DocToc args', () => {
         process.env.GITHUB_WORKSPACE = '/tmp/workspace';
-        process.env.INPUT_TARGET_PATHS = 'README.md,.github/CONTRIBUTING.md';
-        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md /tmp/workspace/.work/.github/CONTRIBUTING.md');
+        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md --notitle');
     });
 });
 

action.yml

@@ -8,6 +8,9 @@ inputs:
   TARGET_PATHS:
     description: Target file path. (Comma separated, @see https://github.com/thlorenz/doctoc#adding-toc-to-individual-files)
     default: 'README.md'
+  TOC_TITLE:
+    description: TOC Title
+    default: '**Table of Contents**'
   COMMIT_MESSAGE:
     description: Commit message.
     default: 'docs: Update TOC'

src/utils/misc.ts

@@ -29,9 +29,12 @@ const getTargetPaths = (): string[] => [...new Set<string>((getInput('TARGET_PAT
 
 export const getDocTocArgs = () => {
     const workDir = getWorkDir();
-    return getTargetPaths().map(item => path.resolve(workDir, item)).join(' ');
+    const title = getTocTitle().replace('\'', '\\\'').replace('"', '\\"');
+    return getTargetPaths().map(item => path.resolve(workDir, item)).join(' ') + (title ? ` --title ${title}` : ' --notitle');
 };
 
+const getTocTitle = (): string => getInput('TOC_TITLE') || '';
+
 const getWorkspace = (): string => process.env.GITHUB_WORKSPACE || '';
 
 export const getWorkDir = () => path.resolve(getWorkspace(), '.work');