Merge pull request #49 from intuit/more-docs

Add CircleCI Troubleshooting
intuit · Dec 14, 2018 · 296f124 · 296f124
2 parents 8b5ba6e + c4d4978
commit 296f124
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@ dist
 coverage
 .DS_store
 package-lock.json
+_ignite
 
 
 # Created by https://www.gitignore.io/api/node,intellij,sublimetext,visualstudiocode

diff --git a/README.md b/README.md
@@ -69,8 +69,9 @@ Make sure to read our [code of conduct](./CODE_OF_CONDUCT.md).
 
 :star: [webpack-inject-plugin](https://github.com/adierkens/webpack-inject-plugin) - A webpack plugin to dynamically inject code into the bundle.
 
-:star: [storybook-addon-notes-github-markdown-css
-](https://github.com/hipstersmoothie/github-markdown-css) - Make your notes addon look like github markdown.
+:star: [storybook-addon-notes-github-markdown-css](https://github.com/hipstersmoothie/github-markdown-css) - Make your notes addon look like github markdown.
+
+:star: [html-webpack-insert-text-plugin](https://github.com/hipstersmoothie/html-webpack-insert-text-plugin) - Insert text into the head or body of your HTML
 
 ## Contributors
 

diff --git a/docs/pages/circleci.md b/docs/pages/circleci.md
@@ -39,3 +39,14 @@ workflows:
               only:
                 - master
 ```
+
+## Troubleshooting
+
+If you are having problems make sure you have done the following:
+
+- `GH_TOKEN` is set
+- `NPM_TOKEN` is set
+
+### Problems pushing tags to github?
+
+Go to Settings -> Checkout SSH Keys -> `Create and add YOUR_USERNAME user key`. This will create a key with the ability to push to github.
diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md
@@ -6,9 +6,48 @@ Before we do anything we must first install `auto-release-cli` as a dev dependen
 yarn add -D auto-release-cli
 ```
 
+## Configuration
+
+To quickly configure most options run `auto init`.
+
+If you do this you still must configure the environment variables and add the labels to your project. `auto init` cannot automate these steps.
+
+### Environment Variables
+
+You must configure some environment variables for publishing and releasing.
+
+- `GH_TOKEN` - Used for updating the changelog and publishing the GitHub release
+- `NPM_TOKEN` - Used to publish to npm.
+
+If you are publishing from the CI you must inject the `NPM_TOKEN` into your `.npmrc`.
+
+```sh
+echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+```
+
+### Labels
+
+After that, set up the labels on your github project. The following labels are the defaults. To change them refer to [this](./autorc.md#versioning-labels).
+
+#### Versioning Labels:
+
+- `major` - create a major release
+- `minor` - create a minor release
+- `patch` - create a patch release
+- `no-release` - do not create a release
+- `release` (optional) - only used with `onlyPublishWithReleaseLabel`
+- `prerelease` (optional) - create pre release
+
+#### 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)
+
+- `internal` - the changes do not effect the code and is more about tooling
+- `documentation` - the changes effect the documentation
+
 ## Quick Setup
 
-To version, changelog, publish and release your code in all at the same time, we've included the `shipit` tool. This tool takes the default `auto` workflow and puts it into one command.
+To version, changelog, publish and release your code all at the same time, we've included the `shipit` tool. This tool takes the default `auto` workflow and puts it into one command.
 
 ```json
 {

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.0",
-    "ignite": "^1.6.4",
+    "ignite": "^1.6.5",
     "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.4:
-  version "1.6.4"
-  resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.4.tgz#5c55c9143414a8beacd203eb445ba0367d73d96f"
-  integrity sha512-QSPr1LAfkx2O34Zo3QF6dBqS7qQ8hBOgCt9cyePPrCEv58IQ10CKwAXY7QhNrble1ORvtOybAtoQ7WAOQWun1w==
+ignite@^1.6.5:
+  version "1.6.5"
+  resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.5.tgz#bd0d2f58496e20f44879bfec116a77166d6f2e84"
+  integrity sha512-cSiEwRcTdUSkRP1PvyXkJKm9lIV1jFWxiMnr3GVb1r2cXPwz4CqorXDKwe60WHFWMKhUc6Orh6lo4Mj7+SWRmQ==
   dependencies:
     "@babel/cli" "7.0.0"
     "@babel/core" "7.0.0"