mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-02 09:44:08 +00:00
Ismo Vuorinen
f94967713a
This commit represents a comprehensive refactoring of the codebase focused on improving code quality, testability, and maintainability. Key improvements: - Implement dependency injection and interface-based architecture - Add comprehensive test framework with fixtures and test suites - Fix all linting issues (errcheck, gosec, staticcheck, goconst, etc.) - Achieve full EditorConfig compliance across all files - Replace hardcoded test data with proper fixture files - Add configuration loader with hierarchical config support - Improve error handling with contextual information - Add progress indicators for better user feedback - Enhance Makefile with help system and improved editorconfig commands - Consolidate constants and remove deprecated code - Strengthen validation logic for GitHub Actions - Add focused consumer interfaces for better separation of concerns Testing improvements: - Add comprehensive integration tests - Implement test executor pattern for better test organization - Create extensive YAML fixture library for testing - Fix all failing tests and improve test coverage - Add validation test fixtures to avoid embedded YAML in Go files Build and tooling: - Update Makefile to show help by default - Fix editorconfig commands to use eclint properly - Add comprehensive help documentation to all make targets - Improve file selection patterns to avoid glob errors This refactoring maintains backward compatibility while significantly improving the internal architecture and developer experience.
142 lines
3.6 KiB
Cheetah
142 lines
3.6 KiB
Cheetah
# {{.Name}}
|
|
|
|
{{if .Branding}} {{end}}
|
|
![GitHub](https://img.shields.io/badge/GitHub%20Action-{{.Name | replace " " "%20"}}-blue)
|
|
|
|
|
|
> {{.Description}}
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```yaml
|
|
name: My Workflow
|
|
on: [push, pull_request]
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: {{.Name}}
|
|
uses: {{gitUsesString .}}
|
|
{{if .Inputs}}with:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key}}: {{if $val.Default}}"{{$val.Default}}"{{else}}"value"{{end}}
|
|
{{- end}}{{end}}
|
|
```
|
|
|
|
{{if .Inputs}}
|
|
## 📥 Inputs
|
|
|
|
| Parameter | Description | Required | Default |
|
|
|-----------|-------------|----------|---------|
|
|
{{- range $key, $input := .Inputs}}
|
|
| `{{$key}}` | {{$input.Description}} | {{if $input.Required}}✅{{else}}❌{{end}} | {{if $input.Default}}`{{$input.Default}}`{{else}}-{{end}} |
|
|
{{- end}}
|
|
{{end}}
|
|
|
|
{{if .Outputs}}
|
|
## 📤 Outputs
|
|
|
|
| Parameter | Description |
|
|
|-----------|-------------|
|
|
{{- range $key, $output := .Outputs}}
|
|
| `{{$key}}` | {{$output.Description}} |
|
|
{{- end}}
|
|
{{end}}
|
|
|
|
## 💡 Examples
|
|
|
|
<details>
|
|
<summary>Basic Usage</summary>
|
|
|
|
```yaml
|
|
- name: {{.Name}}
|
|
uses: {{gitUsesString .}}
|
|
{{if .Inputs}}with:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key}}: {{if $val.Default}}"{{$val.Default}}"{{else}}"example-value"{{end}}
|
|
{{- end}}{{end}}
|
|
```
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Advanced Configuration</summary>
|
|
|
|
```yaml
|
|
- name: {{.Name}} with custom settings
|
|
uses: {{gitUsesString .}}
|
|
{{if .Inputs}}with:
|
|
{{- range $key, $val := .Inputs}}
|
|
{{$key}}: {{if $val.Default}}"{{$val.Default}}"{{else}}"custom-value"{{end}}
|
|
{{- end}}{{end}}
|
|
```
|
|
</details>
|
|
|
|
{{if .Dependencies}}
|
|
## 📦 Dependencies
|
|
|
|
This action uses the following dependencies:
|
|
|
|
| Action | Version | Author | Description |
|
|
|--------|---------|--------|-------------|
|
|
{{- range .Dependencies}}
|
|
| {{if .MarketplaceURL}}[{{.Name}}]({{.MarketplaceURL}}){{else}}{{.Name}}{{end}} | {{if .IsPinned}}🔒{{end}}{{.Version}} | [{{.Author}}](https://github.com/{{.Author}}) | {{.Description}} |
|
|
{{- end}}
|
|
|
|
<details>
|
|
<summary>📋 Dependency Details</summary>
|
|
|
|
{{range .Dependencies}}
|
|
### {{.Name}}{{if .Version}} @ {{.Version}}{{end}}
|
|
|
|
{{if .IsPinned}}
|
|
- 🔒 **Pinned Version**: Locked to specific version for security
|
|
{{else}}
|
|
- 📌 **Floating Version**: Using latest version (consider pinning for security)
|
|
{{end}}
|
|
- 👤 **Author**: [{{.Author}}](https://github.com/{{.Author}})
|
|
{{if .MarketplaceURL}}- 🏪 **Marketplace**: [View on GitHub Marketplace]({{.MarketplaceURL}}){{end}}
|
|
{{if .SourceURL}}- 📂 **Source**: [View Source]({{.SourceURL}}){{end}}
|
|
{{if .WithParams}}
|
|
- **Configuration**:
|
|
```yaml
|
|
with:
|
|
{{- range $key, $value := .WithParams}}
|
|
{{$key}}: {{$value}}
|
|
{{- end}}
|
|
```
|
|
{{end}}
|
|
|
|
{{end}}
|
|
|
|
{{$hasLocalDeps := false}}
|
|
{{range .Dependencies}}{{if .IsLocalAction}}{{$hasLocalDeps = true}}{{end}}{{end}}
|
|
{{if $hasLocalDeps}}
|
|
### Same Repository Dependencies
|
|
{{range .Dependencies}}{{if .IsLocalAction}}
|
|
- [{{.Name}}]({{.SourceURL}}) - {{.Description}}
|
|
{{end}}{{end}}
|
|
{{end}}
|
|
|
|
</details>
|
|
{{end}}
|
|
|
|
## 🔧 Development
|
|
|
|
See the [action.yml](./action.yml) for the complete action specification.
|
|
|
|
## 📄 License
|
|
|
|
This action is distributed under the MIT License. See [LICENSE](LICENSE) for more information.
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
<sub>🚀 Generated with <a href="https://github.com/ivuorinen/gh-action-readme">gh-action-readme</a></sub>
|
|
</div>
|