1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
// file : bdep/release.cli
// copyright : Copyright (c) 2014-2019 Code Synthesis Ltd
// license : MIT; see accompanying LICENSE file
include <set>;
include <bdep/common.cli>;
"\section=1"
"\name=bdep-release"
"\summary=manage project's version during release"
namespace bdep
{
{
"<options>
<prj-spec> <prj-dir>
<pkg-spec> <pkg-dir>",
"\h|SYNOPSIS|
\c{\b{bdep release} [<options>] [<prj-spec>]}
\c{<prj-spec> = \b{--directory}|\b{-d} <prj-dir> | <pkg-spec>\n
<pkg-spec> = (\b{--directory}|\b{-d} <pkg-dir>)...}
\h|DESCRIPTION|
The \cb{release} command manages the project's version during the
release. Specifically, it first changes the snapshot version to the
corresponding release version in each project package's \cb{manifest}
file, commits these changes (unless \cb{--no-commit} is specified), tags
this commit (unless \cb{--no-tag} is specified), and, if \cb{--push} is
specified, pushes the changes to the remote. Unless \cb{--no-open} is
specified, the \cb{release} command then opens the next development cycle
by changing the version to a snapshot, committing these changes (unless
\cb{--no-commit} is specified), and, if \cb{--push} is specified, pushing
them to the remote. Note that committing, tagging, and pushing is
currently only supported for \cb{git(1)} project repositories.
The \cb{release} command can also be used to release a new package
revision by passing the \cb{--revision} option. In this mode \cb{release}
increments the current version's revision component in each project
package's \cb{manifest} file, commits these changes (unless
\cb{--no-commit} is specified), tags this commit (unless \cb{--no-tag} is
specified), and, if \cb{--push} is specified, pushes the changes to the
remote. Note that in this mode \cb{release} will also silently replace an
existing tag for the same version.
When releasing a revision, the project's repository index is expected to
already contain other changes since for a revision all the associated
changes, including to version, must belong to a single commit.
Alternatively, a revision can be released by amending one or more
existing commits using the \cb{--amend} and \cb{--squash} options. In
this case the index may still contain additional changes but is not
required to.
The \cb{release} command also has a number of \i{continue modes} that
allow the completion of steps that were previously suppressed with the
\cb{--no-*} options in the above main modes. These are \cb{--tag} which
tags the release commit and, if \cb{--push} is specified, pushes it to
the remote as well as \cb{--open} which performs the opening of the next
development cycle as described above.
In all the modes that perform a commit, if the project's repository index
already contains other changes, then the commit message is automatically
opened for editing unless \cb{--no-edit} is specified. The editing of the
commit message in the absence of other changes can be requested with the
\cb{--edit} option.
Normally, \cb{release} operates on all the packages in a project. If no
project directory is specified, then the current working directory is
assumed and all the packages are released, even if the current directory
is a package directory. If, however, one or more package directories are
specified explicitly with \c{\b{--directory}|\b{-d}}, then \cb{release}
assumes you know what you are doing and only releases these packages.
All the packages being released must have the same version but may have
different revisions.
"
}
class cmd_release_options: common_options
{
"\h|RELEASE OPTIONS|"
bool --revision
{
"Release a new package revision instead of a new version."
}
bool --no-commit
{
"Don't commit the changes. Implies \cb{--no-tag} and, in the version
release mode, \cb{--no-open}."
}
bool --no-tag
{
"Don't tag the release commit. Tagging can be performed later using the
\cb{--tag} mode option."
}
bool --tag
{
"Tag the already released version instead of releasing a new one."
}
bool --push
{
"Push the committed changes and tags to the remote."
}
bool --show-push
{
"Print the push command instead of executing it. This allows examining
the committed changes and tags before pushing them to the remote. Note
that the command is printed to \cb{stdout}."
}
bool --no-open
{
"Don't open the next development cycle. Opening can be performed later
using the \cb{--open} mode option."
}
bool --open
{
"Open the next development cycle instead of releasing a new version."
}
bool --amend
{
"Release a revision by amending the latest commit instead of making
a new one."
}
size_t --squash = 1
{
"<num>",
"Release a revision by squashing the specified number of previous
commits and then amending the result. Requires the \cb{--amend}
option to be specified."
}
bool --alpha
{
"Release an alpha instead of the final version."
}
bool --beta
{
"Release a beta version instead of the final version."
}
bool --minor
{
"Release the next minor version instead of the current patch."
}
bool --major
{
"Release the next major version instead of the current minor or patch."
}
bool --open-beta
{
"Open the development cycle with the next beta version."
}
bool --open-patch
{
"Open the development cycle with the next patch version. This is the
default if the current patch version is not \c{0} (bugfix release
series)."
}
bool --open-minor
{
"Open the development cycle with the next minor version. This is the
default if the current patch version is \c{0} (feature release series)."
}
bool --open-major
{
"Open the development cycle with the next major version."
}
// We are using string instead of standard_version because its constructor
// is too loose for our needs which means we have to do extra validations
// anyway (pre-release, etc).
//
string --open-base
{
"<version>",
"Open the development cycle with the specified version. The base version
should be in the \c{\i{major}\b{.}\i{minor}\c{.}\i{patch}} form with
the opened version becoming
\c{\i{major}\b{.}\i{minor}\b{.}\i{patch}\b{-a.0.z}}."
}
bool --edit
{
"Open the commit message for editing."
}
bool --no-edit
{
"Don't open the commit message for editing."
}
std::set<string> --force
{
"<check>",
"Force releasing, disabling the specified check. Repeat this option to
disable multiple checks."
}
bool --yes|-y
{
"Don't prompt for confirmation before releasing."
}
dir_paths --directory|-d
{
"<dir>",
"Assume project/package is in the specified directory rather than in the
current working directory."
}
};
}
|