mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-06 06:47:38 +00:00
Ismo Vuorinen
4f12c4d3dd
* chore(lint): added nlreturn, run linting * chore(lint): replace some fmt.Sprintf calls * chore(lint): replace fmt.Sprintf with strconv * chore(lint): add goconst, use http lib for status codes, and methods * chore(lint): use errors lib, errCodes from internal/errors * chore(lint): dupl, thelper and usetesting * chore(lint): fmt.Errorf %v to %w, more linters * chore(lint): paralleltest, where possible * perf(test): optimize test performance by 78% - Implement shared binary building with package-level cache to eliminate redundant builds - Add strategic parallelization to 15+ tests while preserving environment variable isolation - Implement thread-safe fixture caching with RWMutex to reduce I/O operations - Remove unnecessary working directory changes by leveraging embedded templates - Add embedded template system with go:embed directive for reliable template resolution - Fix linting issues: rename sharedBinaryError to errSharedBinary, add nolint directive Performance improvements: - Total test execution time: 12+ seconds → 2.7 seconds (78% faster) - Binary build overhead: 14+ separate builds → 1 shared build (93% reduction) - Parallel execution: Limited → 15+ concurrent tests (60-70% better CPU usage) - I/O operations: 66+ fixture reads → cached with sync.RWMutex (50% reduction) All tests maintain 100% success rate and coverage while running nearly 4x faster.
38 lines
729 B
Cheetah
38 lines
729 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}}
|