feat: improve git tag handling and changelog generation with version-aware commits

Author: shyim

extension/zip.go

@@ -521,14 +521,14 @@ func PrepareExtensionForRelease(ctx context.Context, sourceRoot, extensionRoot s
 	if ext.GetExtensionConfig().Changelog.Enabled {
 		v, _ := ext.GetVersion()
 
-		logging.FromContext(ctx).Infof("Generated changelog for version %s", v.String())
+		logging.FromContext(ctx).Infof("Generated changelog for version %s", v.Original())
 
-		content, err := changelog.GenerateChangelog(ctx, sourceRoot, ext.GetExtensionConfig().Changelog)
+		content, err := changelog.GenerateChangelog(ctx, v.Original(), sourceRoot, ext.GetExtensionConfig().Changelog)
 		if err != nil {
 			return err
 		}
 
-		changelogFile := fmt.Sprintf("# %s\n%s", v.String(), content)
+		changelogFile := fmt.Sprintf("# %s\n%s", v.Original(), content)
 
 		if err := os.WriteFile(path.Join(extensionRoot, "CHANGELOG_en-GB.md"), []byte(changelogFile), os.ModePerm); err != nil {
 			return err

internal/changelog/changelog.go

@@ -35,7 +35,7 @@ type Commit struct {
 }
 
 // GenerateChangelog generates a changelog from the git repository.
-func GenerateChangelog(ctx context.Context, repository string, cfg Config) (string, error) {
+func GenerateChangelog(ctx context.Context, currentVersion string, repository string, cfg Config) (string, error) {
 	var err error
 
 	if cfg.Template == "" {
@@ -50,7 +50,7 @@ func GenerateChangelog(ctx context.Context, repository string, cfg Config) (stri
 		return "", err
 	}
 
-	commits, err := git.GetCommits(ctx, repository)
+	commits, err := git.GetCommits(ctx, currentVersion, repository)
 	if err != nil {
 		return "", err
 	}

internal/git/git.go

@@ -7,6 +7,8 @@ import (
 	"os/exec"
 	"path"
 	"strings"
+
+	"github.com/shopware/shopware-cli/logging"
 )
 
 type GitCommit struct {
@@ -31,7 +33,7 @@ func runGit(ctx context.Context, repo string, args ...string) (string, error) {
 	return strings.Trim(gitOuput, " "), nil
 }
 
-func getPreviousTag(ctx context.Context, repo string) (string, error) {
+func getPreviousTag(ctx context.Context, currentTag, repo string) (string, error) {
 	if err := unshallowRepository(ctx, repo); err != nil {
 		return "", err
 	}
@@ -63,23 +65,36 @@ func getPreviousTag(ctx context.Context, repo string) (string, error) {
 			continue
 		}
 
+		if matchingTags[0] == currentTag {
+			continue
+		}
+
 		return matchingTags[0], nil
 	}
 
 	// if no tag was found, return the first commit
 	return commitsArray[len(commitsArray)-1], nil
 }
 
-func GetCommits(ctx context.Context, repo string) ([]GitCommit, error) {
+func GetCommits(ctx context.Context, currentVersion, repo string) ([]GitCommit, error) {
 	if err := unshallowRepository(ctx, repo); err != nil {
 		return nil, err
 	}
 
-	previousTag, err := getPreviousTag(ctx, repo)
+	currentTag, err := getTagForVersion(ctx, currentVersion, repo)
+	if err != nil {
+		return nil, err
+	}
+
+	logging.FromContext(ctx).Debugf("Current tag: %s", currentTag)
+
+	previousTag, err := getPreviousTag(ctx, currentTag, repo)
 	if err != nil {
 		return nil, err
 	}
 
+	logging.FromContext(ctx).Debugf("Previous tag: %s", previousTag)
+
 	commits, err := runGit(ctx, repo, "log", "--pretty=format:%h|%s", previousTag+"..HEAD", "--no-merges")
 	if err != nil {
 		return nil, fmt.Errorf("cannot get commits: %w", err)
@@ -103,6 +118,33 @@ func GetCommits(ctx context.Context, repo string) ([]GitCommit, error) {
 	return gitCommits, nil
 }
 
+func getTagForVersion(ctx context.Context, version, repo string) (string, error) {
+	version = strings.TrimPrefix(version, "v")
+
+	tags, err := runGit(ctx, repo, "tag", "--list")
+	if err != nil {
+		return "", fmt.Errorf("failed to run git command: %w", err)
+	}
+
+	// direct tag match
+	tagsArray := strings.Split(tags, "\n")
+	for _, tag := range tagsArray {
+		if tag == version {
+			return tag, nil
+		}
+	}
+
+	// tag prefix match
+	for _, tag := range tagsArray {
+		tag = strings.TrimPrefix(tag, "v")
+		if strings.HasPrefix(tag, version) {
+			return tag, nil
+		}
+	}
+
+	return "", nil
+}
+
 func GetPublicVCSURL(ctx context.Context, repo string) (string, error) {
 	origin, err := runGit(ctx, repo, "config", "--get", "remote.origin.url")
 	if err != nil {

internal/git/git_test.go

@@ -13,7 +13,7 @@ func TestInvalidGitRepository(t *testing.T) {
 	repo := "invalid"
 	ctx := t.Context()
 
-	tag, err := getPreviousTag(ctx, repo)
+	tag, err := getPreviousTag(ctx, "", repo)
 	assert.Error(t, err)
 	assert.Empty(t, tag)
 }
@@ -25,11 +25,15 @@ func TestNoTags(t *testing.T) {
 	runCommand(t, tmpDir, "add", "a")
 	runCommand(t, tmpDir, "commit", "-m", "initial commit", "--no-verify", "--no-gpg-sign")
 
-	tag, err := getPreviousTag(t.Context(), tmpDir)
+	tag, err := getPreviousTag(t.Context(), "", tmpDir)
 	assert.NoError(t, err)
 	assert.NotEmpty(t, tag)
 
-	commits, err := GetCommits(t.Context(), tmpDir)
+	currentTag, err := getTagForVersion(t.Context(), "1.0.0", tmpDir)
+	assert.NoError(t, err)
+	assert.Equal(t, "", currentTag)
+
+	commits, err := GetCommits(t.Context(), "", tmpDir)
 	assert.NoError(t, err)
 	assert.Len(t, commits, 0)
 }
@@ -45,11 +49,15 @@ func TestWithOneTagAndCommit(t *testing.T) {
 	runCommand(t, tmpDir, "add", "b")
 	runCommand(t, tmpDir, "commit", "-m", "second commit", "--no-verify", "--no-gpg-sign")
 
-	tag, err := getPreviousTag(t.Context(), tmpDir)
+	tag, err := getPreviousTag(t.Context(), "", tmpDir)
 	assert.NoError(t, err)
 	assert.Equal(t, tag, "v1.0.0")
 
-	commits, err := GetCommits(t.Context(), tmpDir)
+	currentTag, err := getTagForVersion(t.Context(), "1.0.0", tmpDir)
+	assert.NoError(t, err)
+	assert.Equal(t, "1.0.0", currentTag)
+
+	commits, err := GetCommits(t.Context(), "", tmpDir)
 	assert.NoError(t, err)
 	assert.Len(t, commits, 1)
 	assert.Equal(t, commits[0].Message, "second commit")