add init docs

intuit · Dec 14, 2018 · f6ccf37 · f6ccf37
1 parent 364972c
commit f6ccf37
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 7 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -7,6 +7,9 @@
 
 :hammer: Tool APIs :wrench:
 
+- [Setup](pages/auto-init.md)
+  - [auto init](pages/auto-init.md#auto-init)
+  - [auto init-labels](pages/auto-init.md#auto-init-labels)
 - [Publishing](pages/publishing.md)
   - [auto version](pages/auto-version.md)
   - [auto changelog](pages/auto-changelog.md)

diff --git a/docs/pages/auto-init.md b/docs/pages/auto-init.md
@@ -0,0 +1,37 @@
+# Initialization
+
+`auto-release` provides some tools to quickly set up your project. If you do not want to use the interactive experience all these options can be configured via the [.autorc](./autorc.md) and most can be configure via CLI options.
+
+## `auto init`
+
+Interactive setup for most configurable options.
+
+```sh
+$ auto init --help
+
+usage: auto.js init [-h]
+
+Optional arguments:
+  -h, --help  Show this help message and exit.
+```
+
+## `auto init-labels`
+
+Create your projects labels on github.
+
+```sh
+$ auto init-labels --help
+
+usage: auto.js init-labels [-h] [-v] [-vv] [--githubApi GITHUBAPI]
+
+Optional arguments:
+  -h, --help            Show this help message and exit.
+  -v, --verbose         Show some more logs
+  -vv, --very-verbose   Show a lot more logs
+  --githubApi GITHUBAPI
+                        Github API to use
+```
+
+::: message is-warning
+:warning: For this to work you must have a `GH_TOKEN` set, ex: `GH_TOKEN=YOUR_TOKEN auto init-labels`
+:::
diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md
@@ -30,10 +30,10 @@ After that, you need to set up the labels on your github project. The types of l
 - Versioning Labels - used to calculate version numbers and make releases. To change them refer to [this](./autorc.md#versioning-labels).
 - Changelog Labels - These labels do not effect the version calculation but they will change the section the PR displays in the changelog. These are customizable too, and you can even add your own sections. Read more [here](./autorc.md#changelog-titles)
 
-To create the labels for your project on Github, run the following command.
+To create the labels for your project on Github, run the following command with your `GH_TOKEN`.
 
 ```sh
-auto init-labels
+GH_TOKEN=YOUR_TOKEN auto init-labels
 ```
 
 ### 3. Environment Variables

diff --git a/package.json b/package.json
@@ -61,7 +61,7 @@
     "@types/url-join": "^0.8.2",
     "all-contributors-cli": "^5.4.1",
     "husky": "^1.2.1",
-    "ignite": "^1.6.5",
+    "ignite": "^1.6.6",
     "jest": "~23.6.0",
     "lint-staged": "^8.1.0",
     "prettier": "^1.15.3",

diff --git a/yarn.lock b/yarn.lock
@@ -6108,10 +6108,10 @@ iferr@^0.1.5:
   resolved "https://registry.yarnpkg.com/iferr/-/iferr-0.1.5.tgz#c60eed69e6d8fdb6b3104a1fcbca1c192dc5b501"
   integrity sha1-xg7taebY/bazEEofy8ocGS3FtQE=
 
-ignite@^1.6.5:
-  version "1.6.5"
-  resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.5.tgz#bd0d2f58496e20f44879bfec116a77166d6f2e84"
-  integrity sha512-cSiEwRcTdUSkRP1PvyXkJKm9lIV1jFWxiMnr3GVb1r2cXPwz4CqorXDKwe60WHFWMKhUc6Orh6lo4Mj7+SWRmQ==
+ignite@^1.6.6:
+  version "1.6.6"
+  resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.6.tgz#7ad49bddf8dfc1b964197c7aac8b6c779a2b85eb"
+  integrity sha512-kaHhSvWm1LfVXAJKjgPFFYw3s1RTuwAr1ibid1xji1jr53XcyPsw0YgfjcUmEA/YCc0f2G7wp4hVLgH89p2Auw==
   dependencies:
     "@babel/cli" "7.0.0"
     "@babel/core" "7.0.0"