Merge pull request #22 from andstor/release/1.2.0

Release/1.2.0

.github/workflows/versioning.yml

@@ -0,0 +1,15 @@
+name: Update version tag
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  actions-tagger:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Actions-R-Us/actions-tagger@latest
+        with:
+          publish_latest: true
+        env:
+          GITHUB_TOKEN: '${{secrets.GITHUB_TOKEN}}'

CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ## [Unreleased]
 
+## [1.2.0] - 2020-04-21
+### Changed
+- Deprecates the `template_name` input variable in favor of `template`.
+
+### Fixed
+- Correct handling of templates installed from other sources than the npm package registry.
+
+### Added
+- Ability to install a specific version of a template.
+- Automatic updating of major version tag on release (GitHub Action).
+
 ## [1.1.0] - 2020-02-26
 ### Added
 - Checks for existence of files and directories specified in input variables.
@@ -25,7 +36,8 @@ 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.1.0...HEAD
+[Unreleased]: https://github.com/andstor/jsdoc-action/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/andstor/jsdoc-action/compare/v1.1.0...v1.2.0
 [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

@@ -2,7 +2,7 @@
 
 > A GitHub Action to build JSDoc documentation
 
-This is a GitHub Action to build your JavaScript documentation with [JSDoc](https://github.com/jsdoc/jsdoc). JSDoc [templates](https://github.com/jsdoc/jsdoc#templates) are supported. This action can easily be combied with other deployment actions, in order to publish the generated documentation to for example [GitHub Pages](https://pages.github.com).
+This is a GitHub Action to build your JavaScript documentation with [JSDoc](https://github.com/jsdoc/jsdoc). This action can easily be combined with other deployment actions, in order to publish the generated documentation to for example [GitHub Pages](https://pages.github.com). JSDoc [templates](https://github.com/jsdoc/jsdoc#templates) are aslo supported.
 
 The following example [workflow step](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) will generate documentation for all source files in the `./src` directory and output the built files to the `./out` directory.
 
@@ -33,18 +33,18 @@ The following input variables options can/must be configured:
 |`output_dir`|Optional|Output folder for the generated documentation.|`./out`|
 |`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`|Optional|The JSDoc template package to install. Will run `npm install template`.||
 |`template_dir`|Optional|The relative location of the template files directory within the template package.||
 |`front_page`|Optional|The path to a Markdown file to be used as a the front page. Normally `README.md`.||
 
 ## Templates 💅
 
 You can use JSDoc [templates](https://github.com/jsdoc/jsdoc#templates) with this action.  
-Just set the `template_name` input variable to the name of the template you want to use. This needs to be template's package name.
+Just set the `template` input variable to the name of the template you want to use. This needs to be template's package name.
 
 If the template's template files is located somewhere else than the package's root, you need to specify this. Set the `template_dir` input variable to the location of the template folder (contains a `publish.js` file).
 
-For example, to use the JSDoc [DocStrap](https://github.com/docstrap/docstrap) template, set the `template_name` to `ink-docstrap` and the `template_dir` to `template`.
+For example, to use the JSDoc [DocStrap](https://github.com/docstrap/docstrap) template, set the `template` input variable to `ink-docstrap` and the `template_dir` to the string `template`.
 
 ## JSDoc Configuration file 📄
 
@@ -79,7 +79,7 @@ jobs:
           source_dir: ./src
           output_dir: ./out
           config_file: conf.json
-          template_name: minami
+          template: minami
           front_page: README.md
 
       - name: Deploy

action.yml

@@ -17,8 +17,11 @@ inputs:
   config_file:
     description: 'The path to a JSDoc configuration file'
     required: false
+  template:
+    description: 'The JSDoc template to install'
+    required: false
   template_name:
-    description: 'The name of a JSDoc template to install'
+    description: 'This input variable is deprecated in favour of "template"'
     required: false
   template_dir:
     description: 'The relative location of the template files within the template package'