Merge pull request #16 from andstor/develop

v1.1.0

CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ## [Unreleased]
 
+## [1.1.0] - 2020-02-26
+### Added
+- Checks for existence of files and directories specified in input variables.
+
+### Changed
+- Make the `source_dir` input variable optional.
+- Don't set default value of the `recurse` input variable.
+- Don't set default value of the `output_dir` input variable.
+
 ## [1.0.2] - 2020-02-24
 ### Fixed
 - Specifying input files in JSDoc config files.
@@ -16,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ## 1.0.0 - 2020-02-22
 
-[Unreleased]: https://github.com/andstor/jsdoc-action/compare/v1.0.2...HEAD
+[Unreleased]: https://github.com/andstor/jsdoc-action/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/andstor/jsdoc-action/compare/v1.0.2...v1.1.0
 [1.0.2]: https://github.com/andstor/jsdoc-action/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/andstor/jsdoc-action/compare/v1.0.0...v1.0.1

README.md

@@ -11,6 +11,7 @@ The following example [workflow step](https://help.github.com/en/actions/configu
   uses: andstor/jsdoc-action@v1
   with:
     source_dir: ./src
+    recurse: true
     output_dir: ./out
 ```
 
@@ -28,9 +29,9 @@ The following input variables options can/must be configured:
 
 |Input variable|Necessity|Description|Default|
 |----|----|----|----|
-|`source_dir`|Required|Source directory to build documentation from.||
+|`source_dir`|Optional|Source directory to build documentation from.||
 |`output_dir`|Optional|Output folder for the generated documentation.|`./out`|
-|`recurse`|Optional|Recurse into subdirectories when scanning for source files.|`true`|
+|`recurse`|Optional|Recurse into subdirectories when scanning for source files.|`false`|
 |`config_file`|Optional|The path to a JSDoc configuration file.||
 |`template_name`|Optional|The name of a JSDoc template package to install. Will run a `npm install template_name`.||
 |`template_dir`|Optional|The relative location of the template files directory within the template package.||

action.yml

@@ -7,15 +7,13 @@ branding:
 inputs:
   source_dir:
     description: 'Source directory to build documentation from'
-    required: true
+    required: false
   output_dir:
     description: 'Output folder for the generated documentation'
     required: false
-    default: './out'
   recurse:
     description: 'Recurse into subdirectories when scanning for source files'
     required: false
-    default: true
   config_file:
     description: 'The path to a JSDoc configuration file'
     required: false

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsdoc-action",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "GitHub Action to build JSDoc documentation",
   "main": "src/index.js",
   "scripts": {

src/index.js

@@ -8,33 +8,47 @@ async function run() {
   try {
     const GITHUB_WORKSPACE = process.env.GITHUB_WORKSPACE;
 
-    const source_dir = core.getInput('source_dir', { required: true });
-    const recurse = core.getInput('recurse') || true;
-    const output_dir = core.getInput('output_dir') || './out';
+    const source_dir = core.getInput('source_dir');
+    const recurse = core.getInput('recurse');
+    const output_dir = core.getInput('output_dir');
     const config_file = core.getInput('config_file');
     const template_name = core.getInput('template_name');
     const template_dir = core.getInput('template_dir') || '';
     const front_page = core.getInput('front_page');
 
-    if (config_file) {
+    if (source_dir) {
       try {
-        await fs.promises.access(config_file);
+        const srcPath = path.join(GITHUB_WORKSPACE, source_dir);
+        await fs.promises.access(srcPath);
       } catch (error) {
         core.setFailed('⛔️ Source directory does not exist');
         return;
       }
     }
 
+    if (config_file) {
+      try {
+        const configPath = path.join(GITHUB_WORKSPACE, config_file);
+        await fs.promises.access(configPath);
+      } catch (error) {
+        core.setFailed('⛔️ Config file does not exist');
+        return;
+      }
+    }
+
     if (template_name) {
       await installer.install(template_name);
     }
 
     const jsdocPath = path.join(__dirname, '../node_modules/jsdoc/jsdoc.js');
-    const srcPath = path.join(GITHUB_WORKSPACE, source_dir);
 
     let cmd = 'node';
-    let args = [jsdocPath, srcPath];
+    let args = [jsdocPath];
 
+    if (source_dir) {
+      const srcPath = path.join(GITHUB_WORKSPACE, source_dir);
+      args.push(srcPath);
+    }
     if (recurse) {
       args.push('-r');
     }
@@ -50,9 +64,10 @@ async function run() {
       let readmePath = path.join(GITHUB_WORKSPACE, front_page);
       args.push('-R', readmePath);
     }
-    args.push('-d', path.join(GITHUB_WORKSPACE, output_dir));
+    if(output_dir) {
+      args.push('-d', path.join(GITHUB_WORKSPACE, output_dir));
+    }
 
-    //const actionPath = path.join(__dirname, '../');
     core.info(`📝 Generating documentation`);
     await exec.exec(cmd, args);
     core.info(`🎉 Documentation 📖 has ben generated to the ${output_dir} folder 📁`);