refactor(versioning): clean up version calculation and logs

This commit is contained in:
Nightapes
2019-05-16 21:30:35 +02:00
parent d7664eb8e8
commit 9f7d3e3b58
6 changed files with 136 additions and 84 deletions

View File

@@ -1,9 +1,9 @@
commitFormat: angular commitFormat: angular
branch: branch:
master: release master: release
travis: rc sd: rc
beta: beta sds: beta
alpha: alpha travis: alpha
changelog: changelog:
print: all/compact print: all/compact
template: '' template: ''

2
README2.md Normal file
View File

@@ -0,0 +1,2 @@
go build ./cmd/main.go && ./main.exe version next --path /f/Repro/ambassador/
go build ./cmd/main.go && ./main.exe --loglevel debug version set v1.1.1 --path /f/Repro/ambassador/

View File

@@ -15,11 +15,11 @@ type Analyzer struct {
type Rules struct { type Rules struct {
Tag string Tag string
Release string Release string
Enabled bool Changelog bool
} }
type analyzeCommit interface { type analyzeCommit interface {
analyze(commit gitutil.Commit, tag string) (AnalyzedCommit, bool) analyze(commit gitutil.Commit, tag string) (AnalyzedCommit, bool, error)
getRules() []Rules getRules() []Rules
} }
@@ -29,6 +29,7 @@ type AnalyzedCommit struct {
ParsedMessage string ParsedMessage string
Scope string Scope string
ParsedBreakingChangeMessage string ParsedBreakingChangeMessage string
Tag string
} }
//New Analyzer struct for given commit format //New Analyzer struct for given commit format
@@ -45,7 +46,7 @@ func (a *Analyzer) Analyze(commits []gitutil.Commit) map[string][]AnalyzedCommit
var commitAnalayzer analyzeCommit var commitAnalayzer analyzeCommit
switch a.CommitFormat { switch a.CommitFormat {
case "angular": case "angular":
log.Infof("analyze angular format") log.Debugf("Commit format set to angular")
commitAnalayzer = newAngular() commitAnalayzer = newAngular()
} }
@@ -53,18 +54,24 @@ func (a *Analyzer) Analyze(commits []gitutil.Commit) map[string][]AnalyzedCommit
analyzedCommits["major"] = make([]AnalyzedCommit, 0) analyzedCommits["major"] = make([]AnalyzedCommit, 0)
analyzedCommits["minor"] = make([]AnalyzedCommit, 0) analyzedCommits["minor"] = make([]AnalyzedCommit, 0)
analyzedCommits["patch"] = make([]AnalyzedCommit, 0) analyzedCommits["patch"] = make([]AnalyzedCommit, 0)
analyzedCommits["none"] = make([]AnalyzedCommit, 0)
for _, commit := range commits { for _, commit := range commits {
for _, rule := range commitAnalayzer.getRules() { for _, rule := range commitAnalayzer.getRules() {
analyzedCommit, hasBreakingChange := commitAnalayzer.analyze(commit, rule.Tag) analyzedCommit, hasBreakingChange, err := commitAnalayzer.analyze(commit, rule.Tag)
if err == nil {
if hasBreakingChange { if hasBreakingChange {
analyzedCommits["major"] = append(analyzedCommits["major"], analyzedCommit) analyzedCommits["major"] = append(analyzedCommits["major"], analyzedCommit)
} else { } else {
analyzedCommits[rule.Release] = append(analyzedCommits[rule.Release], analyzedCommit) analyzedCommits[rule.Release] = append(analyzedCommits[rule.Release], analyzedCommit)
} }
break
}
} }
} }
log.Debugf("Analyzed commits: major=%d minor=%d patch=%d none=%d", len(analyzedCommits["major"]), len(analyzedCommits["minor"]), len(analyzedCommits["patch"]), len(analyzedCommits["none"]))
return analyzedCommits return analyzedCommits
} }

View File

@@ -2,9 +2,12 @@
package analyzer package analyzer
import ( import (
"fmt"
"regexp" "regexp"
"strings" "strings"
log "github.com/sirupsen/logrus"
"github.com/Nightapes/go-semantic-release/internal/gitutil" "github.com/Nightapes/go-semantic-release/internal/gitutil"
) )
@@ -20,16 +23,41 @@ func newAngular() *angular {
{ {
Tag: "feat", Tag: "feat",
Release: "minor", Release: "minor",
Enabled: true, Changelog: true,
}, },
{ {
Tag: "fix", Tag: "fix",
Release: "patch", Release: "patch",
Enabled: true, Changelog: true,
}, { }, {
Tag: "perf", Tag: "perf",
Release: "patch", Release: "patch",
Enabled: true, Changelog: true,
}, {
Tag: "docs",
Release: "none",
Changelog: false,
},
{
Tag: "style",
Release: "none",
Changelog: false,
}, {
Tag: "refactor",
Release: "none",
Changelog: false,
}, {
Tag: "test",
Release: "none",
Changelog: false,
}, {
Tag: "chore",
Release: "none",
Changelog: false,
}, {
Tag: "build",
Release: "none",
Changelog: false,
}, },
}, },
} }
@@ -39,14 +67,15 @@ func (a *angular) getRules() []Rules {
return a.rules return a.rules
} }
func (a *angular) analyze(commit gitutil.Commit, tag string) (AnalyzedCommit, bool) { func (a *angular) analyze(commit gitutil.Commit, tag string) (AnalyzedCommit, bool, error) {
analyzed := AnalyzedCommit{ analyzed := AnalyzedCommit{
Commit: commit, Commit: commit,
Tag: tag,
} }
re := regexp.MustCompile(strings.Replace(a.regex, "TAG", tag, -1)) re := regexp.MustCompile(strings.Replace(a.regex, "TAG", tag, -1))
matches := re.FindAllStringSubmatch(commit.Message+" "+commit.Message, -1) matches := re.FindAllStringSubmatch(commit.Message, -1)
if len(matches) >= 1 { if len(matches) >= 1 {
if len(matches[0]) >= 3 { if len(matches[0]) >= 3 {
analyzed.Scope = matches[0][2] analyzed.Scope = matches[0][2]
@@ -56,14 +85,17 @@ func (a *angular) analyze(commit gitutil.Commit, tag string) (AnalyzedCommit, bo
if len(splitted) == 1 { if len(splitted) == 1 {
analyzed.ParsedMessage = splitted[0] analyzed.ParsedMessage = splitted[0]
return analyzed, false log.Tracef("%s: found %s", commit.Message, tag)
return analyzed, false, nil
} }
analyzed.ParsedMessage = splitted[0] analyzed.ParsedMessage = splitted[0]
analyzed.ParsedBreakingChangeMessage = splitted[1] analyzed.ParsedBreakingChangeMessage = splitted[1]
return analyzed, true log.Tracef(" %s, BREAKING CHANGE found", commit.Message)
return analyzed, true, nil
} }
} }
return analyzed, false log.Tracef("%s does not match %s, skip", commit.Message, tag)
return analyzed, false, fmt.Errorf("Not found")
} }

View File

@@ -8,6 +8,7 @@ import (
"github.com/Masterminds/semver" "github.com/Masterminds/semver"
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
"gopkg.in/src-d/go-git.v4" "gopkg.in/src-d/go-git.v4"
"gopkg.in/src-d/go-git.v4/plumbing"
"gopkg.in/src-d/go-git.v4/plumbing/object" "gopkg.in/src-d/go-git.v4/plumbing/object"
) )
@@ -62,23 +63,27 @@ func (g *GitUtil) GetBranch() (string, error) {
// GetLastVersion from git tags // GetLastVersion from git tags
func (g *GitUtil) GetLastVersion() (*semver.Version, string, error) { func (g *GitUtil) GetLastVersion() (*semver.Version, string, error) {
log.Debugf("GetLastVersion") var tags []*semver.Version
gitTags, err := g.Repository.Tags()
tagObjects, err := g.Repository.TagObjects()
if err != nil { if err != nil {
return nil, "", err return nil, "", err
} }
var tags []*semver.Version err = gitTags.ForEach(func(p *plumbing.Reference) error {
v, err := semver.NewVersion(p.Name().Short())
err = tagObjects.ForEach(func(t *object.Tag) error { log.Tracef("%+v", p.Name().Short())
v, err := semver.NewVersion(t.Name) if err == nil {
_, err := g.Repository.TagObject(p.Hash())
if err != nil { if err == nil {
log.Debugf("Tag %s is not a valid version, skip", t.Name) log.Debugf("Add tag %s", p.Name().Short())
} else {
log.Debugf("Add tag %s", t.Name)
tags = append(tags, v) tags = append(tags, v)
} else {
log.Debugf("Found tag %s, but is not annotated, skip", err.Error())
}
} else {
log.Debugf("Tag %s is not a valid version, skip", p.Name().Short())
} }
return nil return nil
}) })
@@ -113,7 +118,6 @@ func (g *GitUtil) GetLastVersion() (*semver.Version, string, error) {
// GetCommits from git hash to HEAD // GetCommits from git hash to HEAD
func (g *GitUtil) GetCommits(lastTagHash string) ([]Commit, error) { func (g *GitUtil) GetCommits(lastTagHash string) ([]Commit, error) {
log.Printf("Read head")
ref, err := g.Repository.Head() ref, err := g.Repository.Head()
if err != nil { if err != nil {
return nil, err return nil, err
@@ -129,7 +133,7 @@ func (g *GitUtil) GetCommits(lastTagHash string) ([]Commit, error) {
err = cIter.ForEach(func(c *object.Commit) error { err = cIter.ForEach(func(c *object.Commit) error {
if c.Hash.String() == lastTagHash { if c.Hash.String() == lastTagHash {
log.Infof("%s == %s", c.Hash.String(), lastTagHash) log.Debugf("Found commit with hash %s, will stop here", c.Hash.String())
foundEnd = true foundEnd = true
} }

View File

@@ -43,6 +43,7 @@ func (s *SemanticRelease) GetNextVersion(repro string, force bool) error {
content, err := cache.Read() content, err := cache.Read()
if err == nil && content.Commit == hash { if err == nil && content.Commit == hash {
log.Infof("Found cache, will return cached version %s", content.NextVersion)
fmt.Printf(content.NextVersion) fmt.Printf(content.NextVersion)
return nil return nil
} }
@@ -53,15 +54,13 @@ func (s *SemanticRelease) GetNextVersion(repro string, force bool) error {
if err != nil { if err != nil {
return err return err
} }
var newVersion semver.Version
if lastVersion == nil { if lastVersion == nil {
defaultVersion, _ := semver.NewVersion("1.0.0") defaultVersion, _ := semver.NewVersion("1.0.0")
err := s.SetVersion(defaultVersion.String(), repro) newVersion = *defaultVersion
if err != nil { } else {
return err newVersion = *lastVersion
}
fmt.Printf("%s", defaultVersion.String())
return nil
} }
commits, err := util.GetCommits(lastVersionHash) commits, err := util.GetCommits(lastVersionHash)
@@ -74,52 +73,31 @@ func (s *SemanticRelease) GetNextVersion(repro string, force bool) error {
a := analyzer.New("angular") a := analyzer.New("angular")
result := a.Analyze(commits) result := a.Analyze(commits)
var newVersion semver.Version
currentBranch, err := util.GetBranch() currentBranch, err := util.GetBranch()
if err != nil { if err != nil {
return err return err
} }
newVersion = *lastVersion
if lastVersion.Prerelease() == "" {
if len(result["major"]) > 0 {
newVersion = lastVersion.IncMajor()
} else if len(result["minor"]) > 0 {
newVersion = lastVersion.IncMinor()
} else if len(result["patch"]) > 0 {
newVersion = lastVersion.IncPatch()
}
}
log.Debugf("Test %+v", s.config)
for branch, releaseType := range s.config.Branch { for branch, releaseType := range s.config.Branch {
if currentBranch == branch || strings.HasPrefix(currentBranch, branch) { if currentBranch == branch || strings.HasPrefix(currentBranch, branch) {
log.Debugf("Found branch config for branch %s with release type %s", currentBranch, releaseType) log.Debugf("Found branch config for branch %s with release type %s", currentBranch, releaseType)
switch releaseType { switch releaseType {
case "rc": case "rc", "beta", "alpha":
if newVersion.Prerelease() == "" || !strings.HasPrefix(newVersion.Prerelease(), "rc") { newVersion = incPrerelease(releaseType, newVersion)
newVersion, _ = newVersion.SetPrerelease("rc.0") case "release":
} else { if len(result["major"]) > 0 {
parts := strings.Split(newVersion.Prerelease(), ".") newVersion = newVersion.IncMajor()
if len(parts) == 2 { } else if len(result["minor"]) > 0 {
i, err := strconv.Atoi(parts[1]) newVersion = newVersion.IncMinor()
if err != nil { } else if len(result["patch"]) > 0 {
newVersion, _ = newVersion.SetPrerelease("rc.0") newVersion = newVersion.IncPatch()
log.Warnf("Could not parse release tag %s, use version %s", newVersion.Prerelease(), newVersion.String())
} else {
newVersion, _ = newVersion.SetPrerelease("rc." + strconv.Itoa((i + 1)))
} }
} else {
newVersion, _ = newVersion.SetPrerelease("rc.0")
log.Warnf("Could not parse release tag %s, use version %s", newVersion.Prerelease(), newVersion.String())
} }
} }
} }
} log.Infof("New version %s -> %s", lastVersion.String(), newVersion.String())
} err = saveToCache(util, lastVersion, &newVersion)
err = s.SetVersion(newVersion.String(), repro)
if err != nil { if err != nil {
return err return err
} }
@@ -141,6 +119,16 @@ func (s *SemanticRelease) SetVersion(version string, repro string) error {
return err return err
} }
lastVersion, _, err := util.GetLastVersion()
if err != nil {
return err
}
return saveToCache(util, lastVersion, newVersion)
}
func saveToCache(util *gitutil.GitUtil, lastVersion *semver.Version, nextVersion *semver.Version) error {
hash, err := util.GetHash() hash, err := util.GetHash()
if err != nil { if err != nil {
return err return err
@@ -153,18 +141,37 @@ func (s *SemanticRelease) SetVersion(version string, repro string) error {
newVersionContent := cache.VersionFileContent{ newVersionContent := cache.VersionFileContent{
Commit: hash, Commit: hash,
NextVersion: newVersion.String(), NextVersion: nextVersion.String(),
Branch: branch, Branch: branch,
} }
lastVersion, _, err := util.GetLastVersion()
if err != nil {
return err
}
if lastVersion != nil { if lastVersion != nil {
newVersionContent.Version = lastVersion.String() newVersionContent.Version = lastVersion.String()
} }
log.Debugf("Save %s with hash %s to cache", nextVersion.String(), hash)
return cache.Write(newVersionContent) return cache.Write(newVersionContent)
} }
func incPrerelease(preReleaseType string, version semver.Version) semver.Version {
defaultPrerelease := preReleaseType + ".0"
if version.Prerelease() == "" || !strings.HasPrefix(version.Prerelease(), preReleaseType) {
version, _ = version.SetPrerelease(defaultPrerelease)
} else {
parts := strings.Split(version.Prerelease(), ".")
if len(parts) == 2 {
i, err := strconv.Atoi(parts[1])
if err != nil {
version, _ = version.SetPrerelease(defaultPrerelease)
log.Warnf("Could not parse release tag %s, use version %s", version.Prerelease(), version.String())
} else {
version, _ = version.SetPrerelease(preReleaseType + "." + strconv.Itoa((i + 1)))
}
} else {
version, _ = version.SetPrerelease(defaultPrerelease)
log.Warnf("Could not parse release tag %s, use version %s", version.Prerelease(), version.String())
}
}
return version
}