mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-05 12:45:29 +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.
66 lines
1.9 KiB
Go
66 lines
1.9 KiB
Go
package validation
|
|
|
|
import (
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"regexp"
|
|
|
|
"github.com/ivuorinen/gh-action-readme/internal/git"
|
|
)
|
|
|
|
// IsCommitSHA checks if a version string is a commit SHA.
|
|
func IsCommitSHA(version string) bool {
|
|
// Check if it's a 40-character hex string (full SHA) or 7+ character hex (short SHA)
|
|
re := regexp.MustCompile(`^[a-f0-9]{7,40}$`)
|
|
return len(version) >= 7 && re.MatchString(version)
|
|
}
|
|
|
|
// IsSemanticVersion checks if a version string follows semantic versioning.
|
|
func IsSemanticVersion(version string) bool {
|
|
// Check for vX.Y.Z format (requires major.minor.patch)
|
|
re := regexp.MustCompile(`^v?\d+\.\d+\.\d+(-[a-zA-Z0-9.-]+)?(\+[a-zA-Z0-9.-]+)?$`)
|
|
return re.MatchString(version)
|
|
}
|
|
|
|
// IsVersionPinned checks if a semantic version is pinned to a specific version.
|
|
func IsVersionPinned(version string) bool {
|
|
// Consider it pinned if it specifies patch version (v1.2.3) or is a full commit SHA
|
|
return IsSemanticVersion(version) || (IsCommitSHA(version) && len(version) == 40)
|
|
}
|
|
|
|
// ValidateGitBranch checks if a branch exists in the given repository.
|
|
func ValidateGitBranch(repoRoot, branch string) bool {
|
|
cmd := exec.Command(
|
|
"git",
|
|
"show-ref",
|
|
"--verify",
|
|
"--quiet",
|
|
"refs/heads/"+branch,
|
|
) // #nosec G204 -- branch name validated by git
|
|
cmd.Dir = repoRoot
|
|
return cmd.Run() == nil
|
|
}
|
|
|
|
// ValidateActionYMLPath validates that a path points to a valid action.yml file.
|
|
func ValidateActionYMLPath(path string) error {
|
|
// Check if file exists
|
|
if _, err := os.Stat(path); os.IsNotExist(err) {
|
|
return err
|
|
}
|
|
|
|
// Check if it's an action.yml or action.yaml file
|
|
filename := filepath.Base(path)
|
|
if filename != "action.yml" && filename != "action.yaml" {
|
|
return os.ErrInvalid
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// IsGitRepository checks if the given path is within a git repository.
|
|
func IsGitRepository(path string) bool {
|
|
_, err := git.FindRepositoryRoot(path)
|
|
return err == nil
|
|
}
|