Skip to content

Commit 79dbd80

Browse files
committed
Update README.md
1 parent 2daa901 commit 79dbd80

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,29 @@ Usage: github-release <command> [<args>]
2020
Options:
2121
-V, --version output the version number
2222
--baseurl <baseurl> API endpoint (default: "https://api.github.com")
23-
-T, --token <token> OAuth2 token
24-
-o, --owner <owner> The repository owner.
25-
-r, --repo <repo> The repository name.
23+
-T, --token <token> OAuth2 token (default: null)
24+
-o, --owner <owner> The repository owner. (default: "")
25+
-r, --repo <repo> The repository name. (default: "")
2626
-t, --tag <tag> The name of the tag.
27+
--release-id <id> The release id.
2728
-c, --commitish <value> Specifies the commitish value for tag. Unused if the tag already exists.
28-
-n, --name <name> The name of the release.
29+
-n, --name <name> The name of the release. (default: "")
2930
-b, --body <body> Text describing the contents of the tag.
3031
-d, --draft [value] `true` makes the release a draft, and `false` publishes the release.
3132
-p, --prerelease [value] `true` to identify the release as a prerelease, `false` to identify the release as a full release.
3233
-h, --help output usage information
3334
```
3435

36+
## Commands
37+
38+
### List
39+
40+
```sh
41+
github-release list
42+
--owner cheton \
43+
--repo github-release-cli
44+
```
45+
3546
### Upload
3647

3748
```sh
@@ -82,16 +93,35 @@ github-release upload \
8293

8394
### Delete
8495

96+
#### Delete release assets
97+
8598
You can use glob expressions to match files:
8699
```sh
87100
github-release delete \
88101
--owner cheton \
89102
--repo github-release-cli \
90103
--tag "v0.1.0" \
91-
--name "v0.1.0" \
92104
archive.zip index.html "app.*"
93105
```
94106

107+
#### Delete a release by specifying the tag name
108+
109+
```sh
110+
github-release delete \
111+
--owner cheton \
112+
--repo github-release-cli \
113+
--tag "v0.1.0"
114+
```
115+
116+
#### Delete a release by specifying the release id
117+
118+
```sh
119+
github-release delete \
120+
--owner cheton \
121+
--repo github-release-cli \
122+
--release-id 17994985
123+
```
124+
95125
## Examples
96126

97127
https://github.com/cncjs/cncjs-pendant-tinyweb/blob/master/.travis.yml

0 commit comments

Comments
 (0)