git-release(1)

1GIT-RELEASE(1)                    Git Extras                    GIT-RELEASE(1)
2
3
4

NAME

6       git-release - Commit, tag and push changes to the repository
7

SYNOPSIS

9       git-release  [<tagname>  |  --semver  <name>] [-r <remote>] [-m <commit
10       info>] [--no-empty-commit] [-c] [-s] [-u <key-id>]  [[--]  <hook  argu‐
11       ments...>]
12

DESCRIPTION

14       Commits  changes  with  message  "Release  <tagname>"  or custom commit
15       information, tags with the given <tagname>  and  pushes  the  branch  /
16       tags.
17
18       This  command  always creates a release commit, which could be empty if
19       nothing changed. It works like git merge --no-ff. If you don´t like the
20       behavior, you could add --no-empty-commit to skip it.
21
22       Optionally  it  generates  a changelog (see git-changelog) and a remote
23       can be defined. The order of first -c or -r does not matter.
24
25       If .git/hook/pre-release or .git/hook/post-release exist, they will  be
26       triggered  with  tagname  and  extra  hook  arguments  before/after the
27       release.
28

OPTIONS

30       --semver <name>
31
32       If the latest tag in your repo matches the semver  format  requirement,
33       you  could increase part of it as the new release tag with this option.
34       The name must be one of the major, minor, patch. For  example,  assumed
35       the  latest tag is 4.4.0, with git release --semver minor you will make
36       a new release with tag 4.5.0.
37
38       <tagname>
39
40       The name of the newly created tag. Also used in tag comment.
41
42       -r <remote>
43
44       The "remote" repository that is destination of a push operation: it  is
45       passed to git push.
46
47       -m <commit info>
48
49       use  the  custom  commit  information  instead  of  the default message
50       "Release <tagname>" .
51
52       --no-empty-commit
53
54       Avoid creating empty commit if nothing could be committed.
55
56       -c
57
58       Generates or populates the changelog with all commit message since  the
59       last tag. For more info see git-changelog..
60
61       -s
62
63       Create a signed and annotated tag.
64
65       -u <key ID>
66
67       Create a tag, annotated and signed with the given key.
68
69       [--] hook arguments...
70
71       The   arguments   listed   after  "--"  separator  will  be  passed  to
72       pre/post-release hook following the tagname.
73

EXAMPLES

75       ·   Release commit with the given <tagname>.
76
77           $ git release 0.1.0
78
79       ·   Release commit with the given <tagname> and custom commit message.
80
81           $ git release 0.1.0 -m "+ powerful feature added."
82
83       ·   Release commit with  the  given  <tagname>  and  push  to  specific
84           remote.
85
86           $ git release 0.1.0 -r github
87
88       ·   Release commit with the given <tagname> and populate changelog.
89
90           $ git release 0.1.0 -c
91
92       ·   Release  commit  with  the given <tagname>, populate changelog, and
93           push to specific remote.
94
95           $ git release 0.1.0 -r github -c
96
97       ·   Release commit with the given <tagname>, pass <tagname>  and  extra
98           argument  to release hook, populate changelog, and push to specific
99           remote.
100
101           $ git release 0.1.0 -r github -c -- --signature-required
102
103
104

AUTHOR

106       Written by Tj Holowaychuk <tj@vision-media.ca> Extended by David  Hart‐
107       mann <dh@tsl.io>
108

REPORTING BUGS

110       <https://github.com/tj/git-extras/issues>
111