WIP: Idempotent module tags

src/internal/github/git.go

@@ -8,8 +8,13 @@ import (
 	"strings"
 )
 
-func parseTagsFromStdout(lines []string) ([]string, error) {
-	tags := make([]string, 0, len(lines))
+type Tag struct {
+	Name   string
+	Commit string
+}
+
+func parseTagsFromStdout(lines []string) ([]Tag, error) {
+	tags := make([]Tag, 0, len(lines))
 
 	for _, line := range lines {
 		if !strings.Contains(line, "refs/tags/") {
@@ -20,6 +25,7 @@ func parseTagsFromStdout(lines []string) ([]string, error) {
 		if len(fields) != 2 {
 			return nil, fmt.Errorf("invalid format for tag '%s', expected two fields", line)
 		}
+		commit := fields[0]
 
 		ref := fields[1]
 		if !strings.HasPrefix(ref, "refs/tags/") {
@@ -31,14 +37,15 @@ func parseTagsFromStdout(lines []string) ([]string, error) {
 			return nil, fmt.Errorf("invalid format for tag '%s', no version provided", line)
 		}
 
-		tags = append(tags, tag)
+		tags = append(tags, Tag{Name: tag, Commit: commit})
 	}
 
 	return tags, nil
 }
 
 // GetTags lists the tags of the remote repository and returns the refs/tags/ found
-func (c Client) GetTags(repositoryUrl string) ([]string, error) {
+// Order is not guaranteed
+func (c Client) GetTags(repositoryUrl string) ([]Tag, error) {
 	done := c.cliThrottle()
 	defer done()
 

src/internal/module/build.go

@@ -6,6 +6,7 @@ import (
 	"slices"
 
 	"github.com/opentofu/registry-stable/internal"
+	"github.com/opentofu/registry-stable/internal/github"
 
 	"golang.org/x/mod/semver"
 )
@@ -42,13 +43,13 @@ func (m Module) BuildMetadata() (*Metadata, error) {
 	for _, t := range tags {
 		found := false
 		for _, v := range meta.Versions {
-			if v.Version == t {
+			if v.Version == t.Name {
 				found = true
 				break
 			}
 		}
 		if !found {
-			meta.Versions = append(meta.Versions, Version{Version: t})
+			meta.Versions = append(meta.Versions, Version{Version: t.Name, Ref: t.Commit})
 		}
 	}
 
@@ -60,22 +61,22 @@ func (m Module) BuildMetadata() (*Metadata, error) {
 	return &meta, nil
 }
 
-func (m Module) getSemverTags() ([]string, error) {
+func (m Module) getSemverTags() ([]github.Tag, error) {
 	tags, err := m.Github.GetTags(m.RepositoryURL())
 	if err != nil {
 		return nil, err
 	}
 
-	var semverTags = make([]string, 0)
+	var semverTags = make([]github.Tag, 0)
 	for _, tag := range tags {
-		tagWithPrefix := fmt.Sprintf("v%s", internal.TrimTagPrefix(tag))
+		tagWithPrefix := fmt.Sprintf("v%s", internal.TrimTagPrefix(tag.Name))
 		if semver.IsValid(tagWithPrefix) {
 			semverTags = append(semverTags, tag)
 		}
 	}
 
-	semverSortFunc := func(a, b string) int {
-		return -semver.Compare(fmt.Sprintf(a), fmt.Sprintf(b))
+	semverSortFunc := func(a, b github.Tag) int {
+		return -semver.Compare(a.Name, b.Name)
 	}
 	slices.SortFunc(semverTags, semverSortFunc)
 

src/internal/module/module.go

@@ -15,6 +15,7 @@ import (
 // Version represents a single version of a module.
 type Version struct {
 	Version string `json:"version"` // The version number of the provider. Correlates to a tag in the module repository
+	Ref     string `json:"ref"`     // Identifier that pins the version to a particular point in history
 }
 
 // Metadata represents all the metadata for a module. This includes the list of
@@ -48,7 +49,7 @@ func (m Module) RSSURL() string {
 // the file should just contain a link to GitHub to download the tarball, ie:
 // git::https://github.com/terraform-aws-modules/terraform-aws-iam?ref=v5.30.0
 func (m Module) VersionDownloadURL(version Version) string {
-	return fmt.Sprintf("git::%s?ref=%s", m.RepositoryURL(), version.Version)
+	return fmt.Sprintf("git::%s?ref=%s", m.RepositoryURL(), version.Ref)
 }
 
 // MetadataPath returns the path to the metadata file for the module.

src/internal/provider/build.go

@@ -40,9 +40,9 @@ func (p Provider) getSemverTags() ([]string, error) {
 
 	var semverTags = make([]string, 0)
 	for _, tag := range tags {
-		tagWithPrefix := fmt.Sprintf("v%s", internal.TrimTagPrefix(tag))
+		tagWithPrefix := fmt.Sprintf("v%s", internal.TrimTagPrefix(tag.Name))
 		if semver.IsValid(tagWithPrefix) {
-			semverTags = append(semverTags, tag)
+			semverTags = append(semverTags, tag.Name)
 		}
 	}