tag

Documentation

Overview

Package tag git-tag - git-tag - Create, list, delete or verify a tag object signed with GPG.

SYNOPSIS

Reference: https://git-scm.com/docs/git-tag

git tag [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>] [-e]
	<tagname> [<commit> | <object>]
git tag -d <tagname>…​
git tag [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]
	[--points-at <object>] [--column[=<options>] | --no-column]
	[--create-reflog] [--sort=<key>] [--format=<format>]
	[--[no-]merged [<commit>]] [<pattern>…​]
git tag -v [--format=<format>] <tagname>…​

DESCRIPTION

Add a tag reference in refs/tags/, unless -d/-l/-v is given to delete, list or verify tags.

Index

• func Annotate(g *types.Cmd)
• func Cleanup(mode string) func(*types.Cmd)
• func Color(when string) func(*types.Cmd)
• func Column(options string) func(*types.Cmd)
• func Commit(commit string) func(*types.Cmd)
• func Contains(commit string) func(*types.Cmd)
• func CreateReflog(g *types.Cmd)
• func Edit(g *types.Cmd)
• func File(value string) func(*types.Cmd)
• func Force(g *types.Cmd)
• func Format(format string) func(*types.Cmd)
• func IgnoreCase(g *types.Cmd)
• func List(g *types.Cmd)
• func LocalUser(keyID string) func(*types.Cmd)
• func Merged(commit string) func(*types.Cmd)
• func Message(msg string) func(*types.Cmd)
• func N(num string) func(*types.Cmd)
• func Name(tagName string) func(*types.Cmd)
• func NoColumn(g *types.Cmd)
• func NoContains(commit string) func(*types.Cmd)
• func NoMerged(commit string) func(*types.Cmd)
• func PointsAt(object string) func(*types.Cmd)
• func Sign(g *types.Cmd)
• func Sort(key string) func(*types.Cmd)
• func Verify(g *types.Cmd)

Functions

func Annotate

func Annotate(g *types.Cmd)

Annotate Make an unsigned, annotated tag object. -a, --annotate

func Cleanup

func Cleanup(mode string) func(*types.Cmd)

Cleanup This option sets how the tag message is cleaned up. The <mode> can be one of verbatim, whitespace and strip. The strip mode is default. The verbatim mode does not change message at all, whitespace

removes just leading/trailing whitespace lines and strip removes both whitespace and commentary.

--cleanup=<mode>

func Color

func Color(when string) func(*types.Cmd)

Color Respect any colors specified in the --format option. The <when> field must be one of always, never, or auto (if <when> is absent, behave as if always was given). --color[=<when>]

func Column

func Column(options string) func(*types.Cmd)

Column Display tag listing in columns. See configuration variable column.tag for option syntax.--column and --no-column without options are equivalent to always and never respectively.

This option is only applicable when listing tags without annotation lines.

--column[=<options>]

func Commit

func Commit(commit string) func(*types.Cmd)

Commit <commit>, <object> The object that the new tag will refer to, usually a commit. Defaults to HEAD.

func Contains

func Contains(commit string) func(*types.Cmd)

Contains Only list tags which contain the specified commit (HEAD if not specified). Implies --list. --contains [<commit>]

func CreateReflog

func CreateReflog(g *types.Cmd)

CreateReflog Create a reflog for the tag. To globally enable reflogs for tags, see core.logAllRefUpdates in git-config(1). The negated form --no-create-reflog only overrides an earlier --create-reflog, but

currently does not negate the setting of core.logAllRefUpdates.

--create-reflog

func Edit

func Edit(g *types.Cmd)

Edit The message taken from file with -F and command line with -m are usually used as the tag message unmodified. This option lets you further edit the message taken from these sources. -e, --edit

func File

func File(value string) func(*types.Cmd)

File Take the tag message from the given file. Use - to read the message from the standard input. Implies -a if none of -a, -s, or -u <keyid> is given. -F <file>, --file=<file>

func Force

func Force(g *types.Cmd)

Force Replace an existing tag with the given name (instead of failing). -f, --force

func Format

func Format(format string) func(*types.Cmd)

Format <format> A string that interpolates %(fieldname) from a tag ref being shown and the object it points at. The format is the same as that of git-for-each-ref(1). When unspecified, defaults to %(refname:strip=2).

func IgnoreCase

func IgnoreCase(g *types.Cmd)

IgnoreCase Sorting and filtering tags are case insensitive. -i, --ignore-case

func List

func List(g *types.Cmd)

List List tags. With optional <pattern>..., e.g. git tag --list 'v-*', list only the tags that match the pattern(s).

Running "git tag" without arguments also lists all tags. The pattern is a shell wildcard (i.e., matched using fnmatch(3)). Multiple patterns may be given; if any of them matches, the tag is shown.

This option is implicitly supplied if any other list-like option such as --contains is provided. See the documentation for each of those options for details. -l, --list

func LocalUser

func LocalUser(keyID string) func(*types.Cmd)

LocalUser Make a GPG-signed tag, using the given key. -u <keyid>, --local-user=<keyid>

func Merged

func Merged(commit string) func(*types.Cmd)

Merged Only list tags whose commits are reachable from the specified commit (HEAD if not specified), incompatible with --no-merged. --merged [<commit>]

func Message

func Message(msg string) func(*types.Cmd)

Message Use the given tag message (instead of prompting). If multiple -m options are given, their values are concatenated as separate paragraphs. Implies -a if none of -a, -s, or -u <keyid> is given. -m <msg>, --message=<msg>

func N

func N(num string) func(*types.Cmd)

N <num> specifies how many lines from the annotation, if any, are printed when using -l. Implies --list.

The default is not to print any annotation lines. If no number is given to -n, only the first line is printed. If the tag is not annotated, the commit message is displayed instead. -n<num>

func Name

func Name(tagName string) func(*types.Cmd)

Name [<tagname>] The name of the tag to create, delete, or describe. The new tag name must pass all checks defined by git-check-ref-format(1). Some of these checks may restrict the characters allowed in a tag name.

func NoColumn

func NoColumn(g *types.Cmd)

NoColumn Display tag listing in columns. See configuration variable column.tag for option syntax.--column and --no-column without options are equivalent to always and never respectively.

This option is only applicable when listing tags without annotation lines.

--no-column

func NoContains

func NoContains(commit string) func(*types.Cmd)

NoContains Only list tags which don’t contain the specified commit (HEAD if not specified). Implies --list. --no-contains [<commit>]

func NoMerged

func NoMerged(commit string) func(*types.Cmd)

NoMerged Only list tags whose commits are not reachable from the specified commit (HEAD if not specified), incompatible with --merged. --no-merged [<commit>]

func PointsAt

func PointsAt(object string) func(*types.Cmd)

PointsAt Only list tags of the given object (HEAD if not specified). Implies --list. --points-at <object>

func Sign

func Sign(g *types.Cmd)

Sign Make a GPG-signed tag, using the default e-mail address’s key. -s, --sign

func Sort

func Sort(key string) func(*types.Cmd)

Sort Sort based on the key given. Prefix - to sort in descending order of the value. You may use the --sort=<key> option multiple times, in which case the last key becomes the primary key. Also supports "version:refname" or "v:refname" (tag names are treated as versions). The "version:refname" sort order can also be affected by the "versionsort.suffix" configuration variable. The keys supported are the same as those in git for-each-ref. Sort order defaults to the value configured for the tag.sort variable if it exists, or lexicographic order otherwise. See git-config(1). --sort=<key>

func Verify

func Verify(g *types.Cmd)

Verify Verify the GPG signature of the given tag names. -v, --verify