File tree Expand file tree Collapse file tree 1 file changed +10
-1
lines changed Expand file tree Collapse file tree 1 file changed +10
-1
lines changed Original file line number Diff line number Diff line change @@ -6,10 +6,11 @@ Title: Create
66This is the main command of GitReleaseManager and it is used to create a draft
77set of release notes based on a milestone, which has been set up in GitHub.
88
9- There are two modes of operation when creating a Release. GitReleaseManager can
9+ There are three modes of operation when creating a Release. GitReleaseManager can
1010take as an input the name of the milestone to generate the release notes from.
1111Or, it can take as an input the name of a file which contains the release notes
1212to include in the Release.
13+ Or, it can create a release that doesn't contain any release notes, i.e. it is empty.
1314
1415## ** Required Parameters**
1516
@@ -35,6 +36,8 @@ to include in the Release.
3536 logging to console.
3637- ` -t, --template ` : The path to the file to be used as the template for the
3738 release notes.
39+ - ` --allowEmpty ` : Allow the creation of an empty set of release notes. In this
40+ mode, milestone and input file path will be ignored.
3841
3942## ** Template**
4043
@@ -61,3 +64,9 @@ gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 --token fsdfsf6
6164
6265gitreleasemanager.exe create --inputFilePath c:\t emp\r eleasenotes.md --name 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
6366```
67+
68+ Use GitReleaseManager to create an empty release:
69+
70+ ``` bash
71+ gitreleasemanager.exe create -n 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo --allowEmpty
72+ ```
You can’t perform that action at this time.
0 commit comments