You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
README helper
v0.0.5
A helper to generate the READE file automatically.
Install it via hd:
hd i yaml-readme
# yaml-readme -h
Usage:
yaml-readme [flags]
Flags:
-h, --help help for yaml-readme
-p, --pattern string The glob pattern with Golang spec to find files (default "items/*.yaml")
-t, --template string The template file which should follow Golang template spec (default "README.tpl")
Name | Usage |
---|---|
filename |
The filename of a particular item file. For example, items/good.yaml , the filename is good . |
parentname |
The parent directory name. For example, items/good.yaml , the parent name is items . |
In case you want to ignore some particular items, you can put a key ignore
with value true
. Let's see the following sample:
name: rick
ignore: true