mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-12 13:48:49 +00:00
37 lines
728 B
Cheetah
37 lines
728 B
Cheetah
# {{.Name}}
|
|
|
|
{{if .Branding}}
|
|
> {{.Description}}
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- uses: {{gitUsesString .}}
|
|
with:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key}}: # {{$val.Description}}{{if $val.Default}} (default: {{$val.Default}}){{end}}
|
|
{{- end}}
|
|
```
|
|
|
|
## Inputs
|
|
|
|
{{range $key, $input := .Inputs}}
|
|
- **{{$key}}**: {{$input.Description}}{{if $input.Required}} (**required**){{end}}{{if $input.Default}} (default: {{$input.Default}}){{end}}
|
|
{{end}}
|
|
|
|
{{if .Outputs}}
|
|
## Outputs
|
|
|
|
{{range $key, $output := .Outputs}}
|
|
- **{{$key}}**: {{$output.Description}}
|
|
{{end}}
|
|
{{end}}
|
|
|
|
## Example
|
|
|
|
See the [action.yml](./action.yml) for a full reference.
|
|
|
|
---
|
|
|
|
*Auto-generated by [gh-action-readme](https://github.com/ivuorinen/gh-action-readme)*
|
|
{{end}} |