Skip to content

tags.md

Latest commit

 

History

History
67 lines (48 loc) · 1.9 KB

tags.md

File metadata and controls

67 lines (48 loc) · 1.9 KB
title Git Tags | GitHub API

Tags

  • TOC {:toc}

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

Get a Tag

GET /repos/:owner/: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 only have to create the tag reference - this call would be unnecessary.

POST /repos/:owner/:repo/git/tags

Parameters

Name Type Description
tag string The tag
message string The tag message
object string The SHA of the git object this is tagging
type string The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
tagger hash A hash with information about the individual creating the tag.

The tagger hash contains the following keys:

Name Type Description
name string The name of the author of the tag
email string The email of the author of the tag
date string When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Example Input

<%= json "tag"=> "v0.0.1",
"message" => "initial version\n",
"object" => "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
"type" => "commit",
"tagger"=>
{"name" => "Scott Chacon", "email" => "[email protected]",
"date" => "2011-06-17T14:53:35-07:00"} %>

Response

<%= headers 201, :Location => "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" %> <%= json :gittag %>