Merge pull request #29 from srevinsaju/feature/srev/git-tags

ref, tag and branch for git provider

docs/src/configuration/data_git.md

@@ -23,12 +23,13 @@ data "git" "this" {
 
 ## Arguments Reference
 
-- [`url`](#url) - The URL of the repository to clone
-- [`tag`](#tag) - The tag to checkout
-- [`branch`](#branch) - The branch to checkout
+- [`url`](#url) - The URL of the repository to clone.
+- [`tag`](#tag) - The tag to checkout. `tag` takes precedence over `branch`.
+- [`ref`](#ref) - The reference to checkout, in the format `refs/tags/v3` for example. `ref` takes precedence over `tag` and `branch`.
+- [`branch`](#branch) - The branch to checkout. `ref` and `tag` takes precedence over `branch`.
 - [`destination`](#destination) - The destination directory to clone the repository to, defaults to `"memory"`, which clones into a temporary directory managed by `togomak`
-- [`commit`](#commit) - The commit to checkout
-- [`depth`](#depth) - The depth of the clone
+- [`commit`](#commit) - The commit to checkout.
+- [`depth`](#depth) - The depth of the clone.
 - [`ca_bundle`](#ca_bundle) - The path to a CA bundle file or directory, (deprecated, does nothing).
 - [`auth`](#auth) - The authentication credentials to use when cloning the repository. Structure [documented below](#auth)
 - [`files`](#files) - The files to checkout from the repository. Accepts an array of file paths.

examples/git_tags/togomak.hcl

@@ -0,0 +1,17 @@
+togomak {
+  version = 1
+}
+
+data "git" "repo" {
+  url   = "https://github.com/srevinsaju/togomak"
+  files = ["togomak.hcl"]
+  tag = "v1.2.0"
+}
+
+stage "example" {
+  name   = "example"
+  script = <<-EOT
+  echo '${data.git.repo.files["togomak.hcl"]}'
+  EOT
+
+}

pkg/blocks/data/git.go

@@ -28,6 +28,7 @@ type gitProviderConfig struct {
 	repo        string
 	tag         string
 	branch      string
+	ref         string
 	destination string
 	commit      string
 
@@ -42,6 +43,7 @@ const (
 	GitBlockArgumentUrl         = "url"
 	GitBlockArgumentTag         = "tag"
 	GitBlockArgumentBranch      = "branch"
+	GitBlockArgumentRef         = "ref"
 	GitBlockArgumentDestination = "destination"
 	GitBlockArgumentCommit      = "commit"
 	GitBlockArgumentDepth       = "depth"
@@ -114,6 +116,13 @@ func (e *GitProvider) DecodeBody(body hcl.Body) hcl.Diagnostics {
 		diags = diags.Extend(d)
 	}
 
+	refAttr, ok := content.Attributes[GitBlockArgumentRef]
+	ref := cty.StringVal("")
+	if ok {
+		ref, d = refAttr.Expr.Value(hclContext)
+		diags = diags.Extend(d)
+	}
+
 	commitAttr, ok := content.Attributes[GitBlockArgumentCommit]
 	commit := cty.StringVal("")
 	if ok {
@@ -187,6 +196,7 @@ func (e *GitProvider) DecodeBody(body hcl.Body) hcl.Diagnostics {
 		tag:         tag.AsString(),
 		branch:      branch.AsString(),
 		commit:      commit.AsString(),
+		ref:         ref.AsString(),
 		destination: destination.AsString(),
 		depth:       int(depthInt),
 		caBundle:    []byte(caBundle.AsString()),
@@ -294,15 +304,20 @@ func (e *GitProvider) Attributes(ctx context.Context, id string) (map[string]cty
 	var cloneComplete = make(chan bool)
 	go e.clonePassiveProgressBar(logger, cloneComplete)
 
+	ref := e.cfg.ref
+	if e.cfg.tag != "" {
+		ref = e.cfg.tag
+	} else {
+		ref = e.cfg.branch
+	}
 	opts := git.CloneRepoOptions{
 		Depth:  e.cfg.depth,
-		Branch: e.cfg.branch,
+		Branch: ref,
 		Bare:   false,
 		// TODO: SkipTLSVerify: e.cfg.skipTLSVerify,
 		// TODO: make it configurable
 		Quiet: true,
 	}
-
 	// TODO: implement git submodules
 
 	destination, d := e.resolveDestination(ctx, id)
@@ -410,7 +425,7 @@ func (e *GitProvider) Attributes(ctx context.Context, id string) (map[string]cty
 		})
 	}
 
-	ref, err := repo.ResolveReference("HEAD")
+	ref, err = repo.ResolveReference("HEAD")
 	if err != nil {
 		diags = diags.Append(&hcl.Diagnostic{
 			Severity: hcl.DiagWarning,