Create a tag object - GitHub API

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.

Signature verification object

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The "signing" flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user's account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

curl --location --request POST 'https://api.github.com/repos///git/tags' \ --header 'Content-Type: application/json' \ --data-raw '{ "message": "initial version", "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "tag": "v0.0.1", "tagger": { "date": "2011-06-17T14:53:35-07:00", "email": "octocat@github.com", "name": "Monalisa Octocat" }, "type": "commit" }'

{ "message": "Initial public release", "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "object": { "sha": "string", "type": "string", "url": "http://example.com" }, "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "tag": "v0.0.1", "tagger": { "date": "string", "email": "string", "name": "string" }, "url": "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "verification": { "payload": "string", "reason": "string", "signature": "string", "verified": true } }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

message

string

必需

The tag message.

object

string

必需

The SHA of the git object this is tagging.

tag

string

必需

The tag's name. This is typically a version (e.g., "v0.0.1").

tagger

object

可选

An object with information about the individual creating the tag.

date

string <date-time>

可选

When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

string

必需

The email of the author of the tag

name

string

必需

The name of the author of the tag

type

enum<string>

必需

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

枚举值:

committreeblob

示例

返回响应

🟢201Response

application/json

Body

Metadata for a Git tag

message

string

必需

Message describing the purpose of the tag

示例值:

Initial public release

node_id

string

必需

示例值:

MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==

object

必需

sha

string

必需

type

string

必需

url

string <uri>

必需

sha

string

必需

示例值:

940bd336248efae0f9ee5bc7b2d5c985887b16ac

tag

string

必需

Name of the tag

示例值:

v0.0.1

tagger

object

必需

date

string

必需

string

必需

name

string

必需

url

string <uri>

必需

URL for the tag

示例值:

https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac

verification

object (Verification)

可选

payload

string | null

必需

reason

string

必需

signature

string | null

必需

verified

boolean

必需

🟠422422