Look through lightweight tags pointing to annotated tags. (#212)

Author: maleadt

Project.toml

@@ -1,6 +1,6 @@
 name = "GitHub"
 uuid = "bc5e4493-9b4d-5f90-b8aa-2b2bcaad7a26"
-version = "5.8.1"
+version = "5.8.2"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

src/git/tag.jl

@@ -10,13 +10,25 @@ end
 
 namefield(tag::Tag) = tag.sha
 
-@api_default function tag(api::GitHubAPI, repo, tag_obj; options...)
-    result = gh_get_json(api, "/repos/$(name(repo))/git/refs/tags/$(name(tag_obj))"; options...)
+@api_default function tag(api::GitHubAPI, repo, tag_ref; options...)
+    result = gh_get_json(api, "/repos/$(name(repo))/git/refs/tags/$(name(tag_ref))"; options...)
+    if result["object"]["type"] == "tag"
+        # lightweight tag pointing to an annotated tag
+        result = gh_get_json(api, "/repos/$(name(repo))/git/tags/$(result["object"]["sha"])"; options...)
+    end
     return Tag(result)
 end
 
 @api_default function tags(api::GitHubAPI, repo; options...)
     result, paged_data = gh_get_paged_json(api, "/repos/$(name(repo))/git/refs/tags"; options...)
+    result = map(result) do entry
+        if entry["object"]["type"] == "tag"
+            # lightweight tag pointing to an annotated tag
+            gh_get_json(api, "/repos/$(name(repo))/git/tags/$(entry["object"]["sha"])"; options...)
+        else
+            entry
+        end
+    end
     return map(Tag, result), paged_data
 end
 

test/read_only_api_tests.jl

@@ -240,10 +240,17 @@ end
     @test ref.object["type"] == "commit"
 
     # Tag API
-    reponame = "QuantEcon/Expectations.jl"
-    version = "v1.0.1"
+    reponame = "JuliaGPU/Adapt.jl"
+    ## lightweight tag
+    version = "v0.1.0"
     exptag = tag(reponame, version; auth=auth)
     @test isa(exptag, Tag)
+    @test exptag.object["type"] == "commit"
+    ## lightweight tag pointing to an annotated tag (should return the annotated tag)
+    version = "v3.4.0"
+    exptag = tag(reponame, version; auth=auth)
+    @test isa(exptag, Tag)
+    @test exptag.object["type"] == "commit"
 end
 
 @testset "URI constructions" begin