mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-04 18:45:12 +00:00
Ismo Vuorinen
3fbb608f9f
* feat(deps): update go version, renovate config, tooling * chore(deps): update google/go-github to v74 * feat(deps): migrate from yaml.v3 to goccy/go-yaml * chore(deps): update goccy/go-yaml to v1.18.0 and address security concerns * feat: improve issue templates and project configuration - Update GitHub issue templates with CLI-specific fields for better bug reports - Add specialized templates for documentation, theme, and performance issues - Update pre-commit config to include comprehensive documentation linting - Remove outdated Snyk configuration and security references - Update Go version from 1.23+ to 1.24+ across project - Streamline README.md organization and improve clarity - Update CHANGELOG.md and CLAUDE.md formatting - Create comprehensive CONTRIBUTING.md with development guidelines - Remove TODO.md (replaced by docs/roadmap.md) - Move SECURITY.md to docs/security.md * docs: fix markdown linting violations across documentation * fix: resolve template placeholder issues and improve uses statement generation * fix: remove trailing whitespace from GitHub issue template
95 lines
1.8 KiB
Cheetah
95 lines
1.8 KiB
Cheetah
# {{.Name}}
|
|
|
|
{{if .Branding}}**{{.Branding.Icon}}** {{end}}**{{.Description}}**
|
|
|
|
---
|
|
|
|
## Installation
|
|
|
|
Add this action to your GitLab CI/CD pipeline or GitHub workflow:
|
|
|
|
### GitHub Actions
|
|
|
|
```yaml
|
|
steps:
|
|
- name: {{.Name}}
|
|
uses: {{gitUsesString .}}
|
|
{{if .Inputs}}with:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key}}: {{if $val.Default}}{{$val.Default}}{{else}}value{{end}}
|
|
{{- end}}{{end}}
|
|
```
|
|
|
|
### GitLab CI/CD
|
|
|
|
```yaml
|
|
{{.Name | lower | replace " " "-"}}:
|
|
stage: build
|
|
image: node:20
|
|
script:
|
|
- # Your action logic here
|
|
{{if .Inputs}}variables:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key | upper}}: {{if $val.Default}}{{$val.Default}}{{else}}value{{end}}
|
|
{{- end}}{{end}}
|
|
```
|
|
|
|
## Configuration
|
|
|
|
{{if .Inputs}}
|
|
### Input Parameters
|
|
|
|
{{range $key, $input := .Inputs}}
|
|
#### `{{$key}}`
|
|
- **Description**: {{$input.Description}}
|
|
- **Type**: String{{if $input.Required}}
|
|
- **Required**: Yes{{else}}
|
|
- **Required**: No{{end}}{{if $input.Default}}
|
|
- **Default**: `{{$input.Default}}`{{end}}
|
|
|
|
{{end}}
|
|
{{end}}
|
|
|
|
{{if .Outputs}}
|
|
### Output Parameters
|
|
|
|
{{range $key, $output := .Outputs}}
|
|
#### `{{$key}}`
|
|
- **Description**: {{$output.Description}}
|
|
|
|
{{end}}
|
|
{{end}}
|
|
|
|
## Usage Examples
|
|
|
|
### Basic Example
|
|
|
|
```yaml
|
|
{{.Name | lower | replace " " "-"}}:
|
|
stage: deploy
|
|
script:
|
|
- echo "Using {{.Name}}"
|
|
{{if .Inputs}}variables:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key | upper}}: "{{if $val.Default}}{{$val.Default}}{{else}}example{{end}}"
|
|
{{- end}}{{end}}
|
|
```
|
|
|
|
### Advanced Example
|
|
|
|
For more complex scenarios, refer to the [action.yml](./action.yml) specification.
|
|
|
|
## Documentation
|
|
|
|
- [Action specification](./action.yml)
|
|
- [Usage examples](./examples/)
|
|
- [Contributing guidelines](./CONTRIBUTING.md)
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License.
|
|
|
|
---
|
|
|
|
*Generated with [gh-action-readme](https://github.com/ivuorinen/gh-action-readme)*
|