feat: latest tag

adds handlers for getting commits only till latest tag if it exists

Author: barelyhuman

go.mod

@@ -2,4 +2,7 @@ module github.com/barelyhuman/commitlog
 
 go 1.15
 
-require github.com/go-git/go-git/v5 v5.2.0 
+require (
+	github.com/go-git/go-git v4.7.0+incompatible // indirect
+	github.com/go-git/go-git/v5 v5.2.0
+)

go.sum

@@ -14,6 +14,7 @@ github.com/go-git/go-billy/v5 v5.0.0 h1:7NQHvd9FVid8VL4qVUMm8XifBK+2xCoZ2lSk0agR
 github.com/go-git/go-billy/v5 v5.0.0/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0=
 github.com/go-git/go-git v1.0.0 h1:YcN9iDGDoXuIw0vHls6rINwV416HYa0EB2X+RBsyYp4=
 github.com/go-git/go-git v4.7.0+incompatible h1:+W9rgGY4DOKKdX2x6HxSR7HNeTxqiKrOvKnuittYVdA=
+github.com/go-git/go-git v4.7.0+incompatible/go.mod h1:6+421e08gnZWn30y26Vchf7efgYLe4dl5OQbBSUXShE=
 github.com/go-git/go-git-fixtures/v4 v4.0.2-0.20200613231340-f56387b50c12/go.mod h1:m+ICp2rF3jDhFgEZ/8yziagdT1C+ZpZcrJjappBCDSw=
 github.com/go-git/go-git/v5 v5.2.0 h1:YPBLG/3UK1we1ohRkncLjaXWLW+HKp5QNM/jTli2JgI=
 github.com/go-git/go-git/v5 v5.2.0/go.mod h1:kh02eMX+wdqqxgNMEyq8YgwlIOsDOa9homkUq1PoTMs=

logcategory/log-category.go

@@ -0,0 +1,67 @@
+package logcategory
+
+// LogsByCategory - Type to hold logs by each's category
+type LogsByCategory struct {
+	CI       []string
+	FIX      []string
+	REFACTOR []string
+	FEATURE  []string
+	DOCS     []string
+	OTHER    []string
+}
+
+// GenerateMarkdown - Generate markdown output for the collected commits
+func (logContainer *LogsByCategory) GenerateMarkdown() string {
+	markDownString := ""
+
+	markDownString += "# Changelog  \n"
+
+	if len(logContainer.CI) > 0 {
+		markDownString += "\n\n## CI Changes  \n"
+
+		for _, item := range logContainer.CI {
+			markDownString += item + "\n"
+		}
+	}
+
+	if len(logContainer.FIX) > 0 {
+		markDownString += "\n\n## Fixes  \n"
+		for _, item := range logContainer.FIX {
+			markDownString += item + "\n"
+		}
+	}
+
+	if len(logContainer.REFACTOR) > 0 {
+		markDownString += "\n\n## Performance Fixes  \n"
+
+		for _, item := range logContainer.REFACTOR {
+			markDownString += item + "\n"
+		}
+	}
+
+	if len(logContainer.FEATURE) > 0 {
+
+		markDownString += "\n\n## Feature Fixes  \n"
+		for _, item := range logContainer.FEATURE {
+			markDownString += item + "\n"
+		}
+	}
+
+	if len(logContainer.DOCS) > 0 {
+
+		markDownString += "\n\n## Doc Updates  \n"
+		for _, item := range logContainer.DOCS {
+			markDownString += item + "\n"
+		}
+	}
+
+	if len(logContainer.OTHER) > 0 {
+
+		markDownString += "\n\n## Other Changes  \n"
+		for _, item := range logContainer.OTHER {
+			markDownString += item + "\n"
+		}
+	}
+
+	return markDownString
+}

main.go

@@ -2,79 +2,16 @@ package main
 
 import (
 	"fmt"
+	"log"
 	"os"
 	"strings"
 
+	"github.com/barelyhuman/commitlog/logcategory"
+	"github.com/barelyhuman/commitlog/utils"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing/object"
 )
 
-// LogsByCategory - Type to hold logs by each's category
-type LogsByCategory struct {
-	CI       []string
-	FIX      []string
-	REFACTOR []string
-	FEATURE  []string
-	DOCS     []string
-	OTHER    []string
-}
-
-// GenerateMarkdown - Generate markdown output for the collected commits
-func (logContainer *LogsByCategory) GenerateMarkdown() string {
-	markDownString := ""
-
-	markDownString += "# Changelog  \n"
-
-	if len(logContainer.CI) > 0 {
-		markDownString += "\n\n## CI Changes  \n"
-
-		for _, item := range logContainer.CI {
-			markDownString += item + "\n"
-		}
-	}
-
-	if len(logContainer.FIX) > 0 {
-		markDownString += "\n\n## Fixes  \n"
-		for _, item := range logContainer.FIX {
-			markDownString += item + "\n"
-		}
-	}
-
-	if len(logContainer.REFACTOR) > 0 {
-		markDownString += "\n\n## Performance Fixes  \n"
-
-		for _, item := range logContainer.REFACTOR {
-			markDownString += item + "\n"
-		}
-	}
-
-	if len(logContainer.FEATURE) > 0 {
-
-		markDownString += "\n\n## Feature Fixes  \n"
-		for _, item := range logContainer.FEATURE {
-			markDownString += item + "\n"
-		}
-	}
-
-	if len(logContainer.DOCS) > 0 {
-
-		markDownString += "\n\n## Doc Updates  \n"
-		for _, item := range logContainer.DOCS {
-			markDownString += item + "\n"
-		}
-	}
-
-	if len(logContainer.OTHER) > 0 {
-
-		markDownString += "\n\n## Other Changes  \n"
-		for _, item := range logContainer.OTHER {
-			markDownString += item + "\n"
-		}
-	}
-
-	return markDownString
-}
-
 func normalizeCommit(commitMessage string) string {
 	var message string
 	for i, msg := range strings.Split(commitMessage, "\n") {
@@ -92,9 +29,16 @@ func main() {
 	ref, _ := r.Head()
 	cIter, _ := r.Log(&git.LogOptions{From: ref.Hash()})
 
-	logContainer := new(LogsByCategory)
+	var commits []*object.Commit
 
 	_ = cIter.ForEach(func(c *object.Commit) error {
+		commits = append(commits, c)
+		return nil
+	})
+
+	logContainer := new(logcategory.LogsByCategory)
+
+	for _, c := range commits {
 		switch {
 		case strings.Contains(c.Message, "ci:"):
 			{
@@ -121,9 +65,27 @@ func main() {
 				logContainer.OTHER = append(logContainer.OTHER, c.Hash.String()+" - "+normalizeCommit(c.Message))
 			}
 		}
-		return nil
-	})
+
+		if isCommitToNearestTag(r, c) {
+			break
+		}
+	}
 
 	fmt.Println(logContainer.GenerateMarkdown())
 
 }
+
+func isCommitToNearestTag(repo *git.Repository, commit *object.Commit) bool {
+	latestTag, err := utils.GetLatestTagFromRepository(repo)
+	if err != nil {
+		log.Fatal("Couldn't get latest tag...", err)
+	}
+	if err != nil {
+		log.Fatal("Couldn't access tag...", err)
+	}
+
+	if latestTag != nil {
+		return latestTag.Hash().String() == commit.Hash.String()
+	}
+	return false
+}

utils/latest-tag.go

@@ -0,0 +1,48 @@
+package utils
+
+import (
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/go-git/go-git/v5/plumbing/object"
+)
+
+// GetLatestTagFromRepository - Get the latest Tag reference from the repo
+func GetLatestTagFromRepository(repository *git.Repository) (*plumbing.Reference, error) {
+	tagRefs, err := repository.Tags()
+	if err != nil {
+		return nil, err
+	}
+
+	var latestTagCommit *object.Commit
+	var latestTagName *plumbing.Reference
+	err = tagRefs.ForEach(func(tagRef *plumbing.Reference) error {
+		revision := plumbing.Revision(tagRef.Name().String())
+
+		tagCommitHash, err := repository.ResolveRevision(revision)
+		if err != nil {
+			return err
+		}
+
+		commit, err := repository.CommitObject(*tagCommitHash)
+		if err != nil {
+			return err
+		}
+
+		if latestTagCommit == nil {
+			latestTagCommit = commit
+			latestTagName = tagRef
+		}
+
+		if commit.Committer.When.After(latestTagCommit.Committer.When) {
+			latestTagCommit = commit
+			latestTagName = tagRef
+		}
+
+		return nil
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return latestTagName, nil
+}