-
Notifications
You must be signed in to change notification settings - Fork 15
/
action.yml
63 lines (61 loc) · 1.8 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
name: 📓 GitHub Action's Readme Generator
author: Jamie Nelson <jamie@bitflight.io>
description: Maintain a current README.md with content from the action.yml file
branding:
icon: book-open
color: yellow
inputs:
action:
description: >
The absolute or relative path to the `action.yml` file to read in from.
required: false
default: action.yml
readme:
description: >
The absolute or relative path to the markdown output file that contains
the formatting tokens within it.
required: false
default: README.md
owner:
description: >
The GitHub Action repository owner. i.e: `bitflight-devops`|`your-gh-username`
required: false
repo:
description: >
The GitHub Action repository name. i.e: `github-action-readme-generator`
required: false
save:
description: >
Save the provided values in a `.ghadocs.json` file. This will update
any existing `.ghadocs.json` file that is in place.
required: false
pretty:
description: >
Use `prettier` to pretty print the new README.md file
required: false
versioning_enabled:
description: >
Enable the update of the usage version to match the latest version in the `package.json` file
required: false
version_override:
description: >
Set a specific version to display in the README.md
required: false
version_prefix:
description: >
Prefix the version with this value (if it isn't already prefixed)
required: false
default: v
versioning_default_branch:
description: >
If versioning is disabled show this branch instead
required: false
default: main
title_prefix:
description: >
Add a prefix to the README title
required: false
default: 'GitHub Action: '
runs:
using: 'node16'
main: './dist/index.cjs'