mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-18 09:50:55 +00:00
feat(lint): add many linters, make all the tests run fast! (#23)
* 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.
This commit is contained in:
@@ -3,7 +3,6 @@ package internal
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"text/template"
|
||||
|
||||
@@ -13,6 +12,7 @@ import (
|
||||
"github.com/ivuorinen/gh-action-readme/internal/dependencies"
|
||||
"github.com/ivuorinen/gh-action-readme/internal/git"
|
||||
"github.com/ivuorinen/gh-action-readme/internal/validation"
|
||||
"github.com/ivuorinen/gh-action-readme/templates_embed"
|
||||
)
|
||||
|
||||
const (
|
||||
@@ -70,6 +70,7 @@ func getGitOrg(data any) string {
|
||||
return td.Config.Organization
|
||||
}
|
||||
}
|
||||
|
||||
return defaultOrgPlaceholder
|
||||
}
|
||||
|
||||
@@ -83,6 +84,7 @@ func getGitRepo(data any) string {
|
||||
return td.Config.Repository
|
||||
}
|
||||
}
|
||||
|
||||
return defaultRepoPlaceholder
|
||||
}
|
||||
|
||||
@@ -101,6 +103,7 @@ func getGitUsesString(data any) string {
|
||||
}
|
||||
|
||||
version := formatVersion(getActionVersion(data))
|
||||
|
||||
return buildUsesString(td, org, repo, version)
|
||||
}
|
||||
|
||||
@@ -118,6 +121,7 @@ func formatVersion(version string) string {
|
||||
if !strings.HasPrefix(version, "@") {
|
||||
return "@" + version
|
||||
}
|
||||
|
||||
return version
|
||||
}
|
||||
|
||||
@@ -129,6 +133,7 @@ func buildUsesString(td *TemplateData, org, repo, version string) string {
|
||||
return fmt.Sprintf("%s/%s/%s%s", org, repo, actionName, version)
|
||||
}
|
||||
}
|
||||
|
||||
return fmt.Sprintf("%s/%s%s", org, repo, version)
|
||||
}
|
||||
|
||||
@@ -139,6 +144,7 @@ func getActionVersion(data any) string {
|
||||
return td.Config.Version
|
||||
}
|
||||
}
|
||||
|
||||
return "v1"
|
||||
}
|
||||
|
||||
@@ -217,7 +223,7 @@ func analyzeDependencies(actionPath string, config *AppConfig, gitInfo git.RepoI
|
||||
|
||||
// RenderReadme renders a README using a Go template and the parsed action.yml data.
|
||||
func RenderReadme(action any, opts TemplateOptions) (string, error) {
|
||||
tmplContent, err := os.ReadFile(opts.TemplatePath)
|
||||
tmplContent, err := templates_embed.ReadTemplate(opts.TemplatePath)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
@@ -229,11 +235,11 @@ func RenderReadme(action any, opts TemplateOptions) (string, error) {
|
||||
}
|
||||
var head, foot string
|
||||
if opts.HeaderPath != "" {
|
||||
h, _ := os.ReadFile(opts.HeaderPath)
|
||||
h, _ := templates_embed.ReadTemplate(opts.HeaderPath)
|
||||
head = string(h)
|
||||
}
|
||||
if opts.FooterPath != "" {
|
||||
f, _ := os.ReadFile(opts.FooterPath)
|
||||
f, _ := templates_embed.ReadTemplate(opts.FooterPath)
|
||||
foot = string(f)
|
||||
}
|
||||
// Wrap template output in header/footer
|
||||
@@ -243,6 +249,7 @@ func RenderReadme(action any, opts TemplateOptions) (string, error) {
|
||||
return "", err
|
||||
}
|
||||
buf.WriteString(foot)
|
||||
|
||||
return buf.String(), nil
|
||||
}
|
||||
|
||||
@@ -254,5 +261,6 @@ func RenderReadme(action any, opts TemplateOptions) (string, error) {
|
||||
if err := tmpl.Execute(buf, action); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return buf.String(), nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user