Skip to content

Commit 56f9ae3

Browse files
committed
Documents supported environment variables
1 parent 8d13f3c commit 56f9ae3

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,37 @@ Yet another Github release command line tool. This one, though, is much more min
66
Github command line release tool.
77
88
Usage:
9-
github-release <user/repo> <tag> <branch> <description> <files>
9+
github-release <user/repo> <tag> <branch> <description> <files>
1010
1111
Parameters:
12-
<user/repo>: Github user and repository
13-
<tag>: Used to created the release. It is also used as the release's name
14-
<branch>: Reference from where to create the provided <tag>, if it does not exist
15-
<description>: The release description
16-
<files>: Glob pattern describing the list of files to include in the release
12+
<user/repo>: Github user and repository
13+
<tag>: Used to created the release. It is also used as the release's name
14+
<branch>: Reference from where to create the provided <tag>, if it does not exist
15+
<description>: The release description
16+
<files>: Glob pattern describing the list of files to include in the release
1717
1818
Options:
19-
-version: Displays version
19+
-version: Displays version
20+
21+
Environment variables:
22+
DEBUG: Allows you to run github-release in debugging mode. DO NOT do this if you are attempting to upload big files.
23+
GITHUB_TOKEN: Must be set in order to interact with Github's API
24+
GITHUB_USER: Just in case you want an alternative way of providing your github user
25+
GITHUB_REPO: Just in case you want an alternative way of providing your github repo
26+
GITHUB_API: Github API endpoint. Set to https://api.github.com/repos/:github-user/:github-repo" by default
2027
2128
Before using this tool make sure you set the environment variable GITHUB_TOKEN
2229
with a valid Github token and correct authorization scopes to allow you to create releases
2330
in your project. For more information about creating Github tokens please read the
2431
official Github documentation at https://help.github.com/articles/creating-an-access-token-for-command-line-use/
32+
33+
Author: https://github.com/c4milo
34+
License: http://mozilla.org/MPL/2.0/
35+
2536
```
2637

2738
### Examples
2839
Feel free to inspect this project's [Makefile](https://github.com/c4milo/github-release/blob/master/Makefile) for an example on how this tool can be used to create releases like this:
2940

3041
![](https://cldup.com/lTTZG_KQXI.png)
42+

main.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,20 @@ Parameters:
7171
Options:
7272
-version: Displays version
7373
74+
Environment variables:
75+
DEBUG: Allows you to run github-release in debugging mode. DO NOT do this if you are attempting to upload big files.
76+
GITHUB_TOKEN: Must be set in order to interact with Github's API
77+
GITHUB_USER: Just in case you want an alternative way of providing your github user
78+
GITHUB_REPO: Just in case you want an alternative way of providing your github repo
79+
GITHUB_API: Github API endpoint. Set to https://api.github.com/repos/:github-user/:github-repo" by default
80+
7481
Before using this tool make sure you set the environment variable GITHUB_TOKEN
7582
with a valid Github token and correct authorization scopes to allow you to create releases
7683
in your project. For more information about creating Github tokens please read the
7784
official Github documentation at https://help.github.com/articles/creating-an-access-token-for-command-line-use/
7885
86+
Author: https://github.com/c4milo
87+
License: http://mozilla.org/MPL/2.0/
7988
`
8089

8190
func main() {

0 commit comments

Comments
 (0)