Skip to content

Commit 359cba9

Browse files
lindelllindell
committed
Added information about command line flags
1 parent a4b3463 commit 359cba9

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,21 @@ Github release CLI is a tool primarily created to circumvent the Travis issue th
55
🔧 Usage
66
----
77
The github-travis-releaser takes enviroment variables from travis and parses them so that you don't have to.
8-
The only variables you need to take into concideration are:
98

9+
#### The only variables you need to take into concideration are:
1010
| Name | Optional | Description |
1111
|------|----------|-------------|
1212
| GITHUB_OATH_TOKEN | `true` | The oath token from github, needed to get the access to create the release |
1313
| BODY | `false` | The body of the release, can be markdown. It's recomended to use `$(envsubst < ./CHANGELOG.md)` or `$(cat ./CHANGELOG.md)` for longer bodies |
1414
| FILES | `false` | The path to the file(s) that should be uploaded. Wildcards can be used (e.g. `release-files/*`) |
1515
| RELEASE_NAME | `false` | The name (title) of the release. If nothing is set, it will be the same as the tag name |
1616

17+
#### Command line flags:
18+
| Name | Description |
19+
|------|-------------|
20+
| -draft | Set the release as a draft |
21+
| -verbose | Print logging statements |
22+
1723
### Example `.travis.yml`
1824
```yaml
1925
before_deploy:

‎assets/CHANGELOG.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
🔧 Usage
22
----
33
The github-travis-releaser takes enviroment variables from travis and parses them so that you don't have to.
4-
The only variables you need to take into concideration are:
54

5+
#### The only variables you need to take into concideration are:
66
| Name | Optional | Description |
77
|------|----------|-------------|
88
| GITHUB_OATH_TOKEN | `true` | The oath token from github, needed to get the access to create the release |
99
| BODY | `false` | The body of the release, can be markdown. It's recomended to use `$(envsubst < ./CHANGELOG.md)` or `$(cat ./CHANGELOG.md)` for longer bodies |
1010
| FILES | `false` | The path to the file(s) that should be uploaded. Wildcards can be used (e.g. `release-files/*`) |
1111
| RELEASE_NAME | `false` | The name (title) of the release. If nothing is set, it will be the same as the tag name |
1212

13+
#### Command line flags:
14+
| Name | Description |
15+
|------|-------------|
16+
| -draft | Set the release as a draft |
17+
| -verbose | Print logging statements |
18+
1319
### Example `.travis.yml`
1420
```yaml
1521
before_deploy:

0 commit comments

Comments
 (0)