ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-03-06 15:57:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: go 1.25.5, dependency updates, renamed internal/errors (#129)

Browse Source 
* feat: rename internal/errors to internal/apperrors

* fix(tests): clear env values before using in tests

* feat: rename internal/errors to internal/apperrors

* chore(deps): update go and all dependencies

* chore: remove renovate from pre-commit, formatting

* chore: sonarcloud fixes

* feat: consolidate constants to appconstants/constants.go

* chore: sonarcloud fixes

* feat: simplification, deduplication, test utils

* chore: sonarcloud fixes

* chore: sonarcloud fixes

* chore: sonarcloud fixes

* chore: sonarcloud fixes

* chore: clean up

* fix: config discovery, const deduplication

* chore: fixes
This commit is contained in:
Ismo Vuorinen
2026-01-01 23:17:29 +02:00
committed by GitHub
parent 85a439d804
commit 7f80105ff5
65 changed files with 2321 additions and 1710 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
internal/validator.go
View File

@@ -3,6 +3,8 @@ package internal
import (
"fmt"
"strings"
"github.com/ivuorinen/gh-action-readme/appconstants"
)
// ValidationResult holds the results of action.yml validation.
@@ -18,18 +20,18 @@ func ValidateActionYML(action *ActionYML) ValidationResult {
// Validate required fields with helpful suggestions
if action.Name == "" {
result.MissingFields = append(result.MissingFields, "name")
result.MissingFields = append(result.MissingFields, appconstants.FieldName)
result.Suggestions = append(result.Suggestions, "Add 'name: Your Action Name' to describe your action")
}
if action.Description == "" {
result.MissingFields = append(result.MissingFields, "description")
result.MissingFields = append(result.MissingFields, appconstants.FieldDescription)
result.Suggestions = append(
result.Suggestions,
"Add 'description: Brief description of what your action does' for better documentation",
)
}
if len(action.Runs) == 0 {
result.MissingFields = append(result.MissingFields, "runs")
result.MissingFields = append(result.MissingFields, appconstants.FieldRuns)
result.Suggestions = append(
result.Suggestions,
"Add 'runs:' section with 'using: node20' or 'using: docker' and specify the main file",
@@ -38,14 +40,14 @@ func ValidateActionYML(action *ActionYML) ValidationResult {
// Validate the runs section content
if using, ok := action.Runs["using"].(string); ok {
if !isValidRuntime(using) {
result.MissingFields = append(result.MissingFields, "runs.using")
result.MissingFields = append(result.MissingFields, appconstants.FieldRunsUsing)
result.Suggestions = append(
result.Suggestions,
fmt.Sprintf("Invalid runtime '%s'. Valid runtimes: node12, node16, node20, docker, composite", using),
)
}
} else {
result.MissingFields = append(result.MissingFields, "runs.using")
result.MissingFields = append(result.MissingFields, appconstants.FieldRunsUsing)
result.Suggestions = append(
result.Suggestions,
"Missing 'using' field in runs section. Specify 'using: node20', 'using: docker', or 'using: composite'",