You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/nbgv-cli.md
+43Lines changed: 43 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,49 @@ The behaviour of the `prepare-release` command can be customized in
121
121
| versionIncrement |`minor`| Specifies which part of the version on the current branch is incremented when preparing a release. Allowed values are `major`, `minor` and `build`. |
122
122
| firstUnstableTag |`alpha`| Specified the unstable tag to use for the main branch. |
123
123
124
+
### Customizing the `prepare-release` output format
125
+
126
+
By default, the `prepare-release` command writes information about created and updated branches to the console as text.
127
+
Alternatively the information can be written to the output as `json`.
128
+
The output format to use can be set using the `--format` command line parameter.
129
+
130
+
For example, running the follwoing command on `master`
-`CurrentBranch` provides information about the branch `prepare-release` was started on (typically `master`)
156
+
-`NewBranch` provides information about the new branch created by the command.
157
+
158
+
For each branch, the following proprties are provided:
159
+
160
+
-`Name`: The name of the branch
161
+
-`Commit`: The id of the latest commit on that branch
162
+
-`Version`: The version configured in that branch's `version.json`
163
+
164
+
**Note:** When the current branch is already the release branch for the current version, no new branch will be created.
165
+
In that case, the `NewBranch` property will be `null`.
166
+
124
167
## Learn more
125
168
126
169
There are several more sub-commands and switches to each to help you build and maintain your projects, find a commit that built a particular version later on, create tags, etc.
0 commit comments