Skip to content

tags.md

Latest commit

 

History

History
59 lines (39 loc) · 1.22 KB

tags.md

File metadata and controls

59 lines (39 loc) · 1.22 KB
Raw
title Git Tags | GitHub API

Tags API

This tags API only deals with tag objects - so only annotated tags, not lightweight tags.

Get a Tag

GET /repos/:user/:repo/git/tags/:sha

Response

<%= headers 200 %> <%= json :gittag %>

Create a Tag Object

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.

POST /repos/:user/:repo/git/tags

Parameters

tag : String of the tag

message : String of the tag message

object : String of the SHA of the git object this is tagging

type : String of the type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

tagger.name : String of the name of the author of the tag

tagger.email : String of the email of the author of the tag

tagger.date : Timestamp of when this object was tagged

Response

<%= headers 201, :Location => "https://api.github.com/repos/:user/:repo/git/tags/:sha" %> <%= json :gittag %>