-
Notifications
You must be signed in to change notification settings - Fork 10
/
action.yml
34 lines (34 loc) · 1.02 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
name: 'JSDoc Action'
description: 'GitHub Action to build JSDoc documentation'
author: 'André Storhaug'
branding:
icon: 'file-text'
color: 'yellow'
inputs:
source_dir:
description: 'Source directory to build documentation from'
required: false
output_dir:
description: 'Output folder for the generated documentation'
required: false
recurse:
description: 'Recurse into subdirectories when scanning for source files'
required: false
config_file:
description: 'The path to a JSDoc configuration file'
required: false
template:
description: 'The JSDoc template to install'
required: false
template_name:
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'
required: false
front_page:
description: 'The path to a Markdown file to be used as a the front page'
required: false
runs:
using: 'node12'
main: 'src/index.js'