mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-01-26 03:04:10 +00:00
33 lines
607 B
Cheetah
33 lines
607 B
Cheetah
# {{.Name}}
|
|
|
|
{{.Description}}
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- uses: your-org/{{.Name | lower | replace " " "-"}}@v1
|
|
{{if .Inputs}}with:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key}}: {{if $val.Default}}{{$val.Default}}{{else}}value{{end}}
|
|
{{- end}}{{end}}
|
|
```
|
|
|
|
{{if .Inputs}}
|
|
## Inputs
|
|
|
|
{{range $key, $input := .Inputs}}
|
|
- `{{$key}}` - {{$input.Description}}{{if $input.Required}} (required){{end}}{{if $input.Default}} (default: `{{$input.Default}}`){{end}}
|
|
{{end}}
|
|
{{end}}
|
|
|
|
{{if .Outputs}}
|
|
## Outputs
|
|
|
|
{{range $key, $output := .Outputs}}
|
|
- `{{$key}}` - {{$output.Description}}
|
|
{{end}}
|
|
{{end}}
|
|
|
|
## License
|
|
|
|
MIT |