docs: document GH_TOKEN #1224

Close #1224
electron-userland · Mar 25, 2017 · 4c83b3f · 4c83b3f
1 parent be698a8
commit 4c83b3f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git a/docs/Publishing Artifacts.md b/docs/Publishing Artifacts.md
@@ -1,6 +1,6 @@
 Travis and AppVeyor support publishing artifacts. But it requires additional configuration for each CI (since AppVeyor can build only Windows and Travis only macOS / Linux).
 
-`electron-builder` allows you to just add `GH_TOKEN` environment variable and that's all.
+`electron-builder` allows you to just set `GH_TOKEN` environment variable and that's all.
 
 Currently, [GitHub Releases](https://help.github.com/articles/about-releases/), [Amazon S3](https://aws.amazon.com/s3/) and [Bintray](https://bintray.com) are supported.
 
@@ -49,13 +49,6 @@ But please consider using automatic rules instead of explicitly specifying `publ
  ```
  and if you run `npm run release`, a release will be drafted (if doesn't already exist) and artifacts published.
 
-## GitHub Repository and Bintray Package
-
- Detected automatically using:
- * [repository](https://docs.npmjs.com/files/package.json#repository) in the application or development `package.json`,
- * if not set, env `TRAVIS_REPO_SLUG` or `APPVEYOR_ACCOUNT_NAME`/`APPVEYOR_PROJECT_NAME` or `CIRCLE_PROJECT_USERNAME`/`CIRCLE_PROJECT_REPONAME`,
- * if no env, from `.git/config` origin url.
-
 ## Publish Options
 
 See [GithubOptions](#GithubOptions), [S3Options](#S3Options), [BintrayOptions](#BintrayOptions).
@@ -68,6 +61,13 @@ Can be specified in the [configuration options](https://github.com/electron-user
 }
 ```
 
+## GitHub Repository and Bintray Package
+
+ Detected automatically using:
+ * [repository](https://docs.npmjs.com/files/package.json#repository) in the application or development `package.json`,
+ * if not set, env `TRAVIS_REPO_SLUG` or `APPVEYOR_ACCOUNT_NAME`/`APPVEYOR_PROJECT_NAME` or `CIRCLE_PROJECT_USERNAME`/`CIRCLE_PROJECT_REPONAME`,
+ * if no env, from `.git/config` origin url.
+
 <!-- do not edit. start of generated block -->
 ## API
 

diff --git a/packages/electron-builder-http/src/publishOptions.ts b/packages/electron-builder-http/src/publishOptions.ts
@@ -28,6 +28,9 @@ export interface PublishConfiguration {
 
 /**
  * GitHub options.
+ * 
+ * GitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.
+ * Define `GH_TOKEN` environment variable.
  */
 export interface GithubOptions extends PublishConfiguration {
   /**