Skip to content

Commit 553a402

Browse files
committed
(doc) Add information about discard command
1 parent 74c66e7 commit 553a402

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

docs/input/docs/commands/discard.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
Order: 20
3+
Title: Discard
4+
---
5+
6+
After creating a draft release, it might be necessary to also discard it. This
7+
could be for a number of reasons, which don't need to be detailed here, but
8+
if/when required, this command will discard a draft release.
9+
10+
:::{.alert .alert-info}
11+
**NOTE:**
12+
The command will only work for releases that are in the draft state. It won't
13+
delete a published release.
14+
:::
15+
16+
## **Required Parameters**
17+
18+
- `-u, --username`: The username to access GitHub with. This can't be used when
19+
using the token parameter.
20+
- `-p, --password`: The password to access GitHub with. This can't be used when
21+
using the token parameter.
22+
- `--token`: The access token to access GitHub with. This can't be used when
23+
using the username and password parameters.
24+
- `-o, --owner`: The owner of the repository.
25+
- `-r, --repository`: The name of the repository.
26+
- `-m, --milestone`: The name of the release (Typically this is the generated
27+
SemVer Version Number).
28+
29+
## **Optional Parameters**
30+
31+
- `-d, -targetDirectory`: The directory on which GitReleaseManager should be
32+
executed. Defaults to current directory.
33+
- `-l, -logFilePath`: Path to where log file should be created. Defaults to
34+
logging to console.
35+
36+
## **Notes**
37+
38+
For Authentication use either username and password, or token parameter
39+
40+
## **Examples**
41+
42+
```bash
43+
gitreleasemanager.exe discard -m 0.1.0 -u bob -p password -o repoOwner -r repo
44+
45+
gitreleasemanager.exe discard --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
46+
47+
gitreleasemanager.exe discard --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
48+
```

0 commit comments

Comments
 (0)