Skip to content

Commit 74c66e7

Browse files
committed
(doc) Added information about open command
1 parent c8a5575 commit 74c66e7

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

docs/input/docs/commands/open.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
Order: 50
3+
Title: Open
4+
---
5+
6+
Depending on the workflow that is being followed, closing on a milestone is
7+
something that is typically done once a release has been published. However, it
8+
might also be necessary to revert closing of a milestone. There are several
9+
reasons _why_ this might be necessary, which aren't really important to go into
10+
here, but this command allow you to open a closed milestone.
11+
12+
:::{.alert .alert-info}
13+
**NOTE:**
14+
15+
This command will _only_ work against a currently closed milestone. No action
16+
will be taken against a milestone that is already open.
17+
:::
18+
19+
## **Required Parameters**
20+
21+
- `-u, --username`: The username to access GitHub with. This can't be used when
22+
using the token parameter.
23+
- `-p, --password`: The password to access GitHub with. This can't be used when
24+
using the token parameter.
25+
- `--token`: The access token to access GitHub with. This can't be used when
26+
using the username and password parameters.
27+
- `-o, --owner`: The owner of the repository.
28+
- `-r, --repository`: The name of the repository.
29+
- `-m, --milestone`: The milestone to use.
30+
31+
## **Optional Parameters**
32+
33+
- `-d, --targetDirectory`: The directory on which GitReleaseManager should be
34+
executed. Defaults to current directory.
35+
- `-l, --logFilePath`: Path to where log file should be created. Defaults to
36+
logging to console.
37+
38+
## **Notes**
39+
40+
For Authentication use either username and password, or token parameter
41+
42+
## **Examples**
43+
44+
```bash
45+
gitreleasemanager.exe open -m 0.1.0 -u bob -p password -o repoOwner -r repo
46+
47+
gitreleasemanager.exe open --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
48+
49+
gitreleasemanager.exe open --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
50+
```

0 commit comments

Comments
 (0)