diff --git a/README.md b/README.md index eeb01f383..11dcd85e5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

Generate releases based on semantic version labels on pull requests

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! + +### Adding a Contributor + +To add a contributor run `yarn contributors:add`, choose "Add new contributor or edit contribution type" and follow the prompts. diff --git a/docs/pages/auto-changelog.md b/docs/pages/auto-changelog.md index bf48f210f..8b7623ab2 100644 --- a/docs/pages/auto-changelog.md +++ b/docs/pages/auto-changelog.md @@ -37,7 +37,7 @@ Optional arguments: ## Jira -To include Jira story information you must include a URL to your hosted JIRA instance as a CLI or `.autorc` config option. +To include Jira story information you must include a URL to your hosted JIRA instance as a CLI or [.autorc`](./autorc.md) config option. ## Changelog Titles diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md index 8e445175b..627ff4a60 100644 --- a/docs/pages/getting-started.md +++ b/docs/pages/getting-started.md @@ -6,9 +6,21 @@ Before we do anything we must first install `auto-release-cli` as a dev dependen yarn add -D auto-release-cli ``` -## Setup +## Quick Setup -The simplest workflow to get set up is adding the following to your `package.json`. With this setup your application will not be able to use the `no-release` flag, but everything else will work just fine +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. + +```json +{ + "scripts": { + "release": "auto shipit" + } +} +``` + +## Detailed Setup + +The simplest workflow to get set up in just the `package.json` is by adding the following to your `package.json`. With this setup your application will not be able to use the `no-release` flag, but everything else will work just fine ```json { @@ -20,9 +32,9 @@ The simplest workflow to get set up is adding the following to your `package.jso } ``` -## Enabling `no-release` label +### Enabling `no-release` label -To use the `no-release` label you have to use a little more involved bash script. We could do the if checks in the `package.json` but this would get messy and hard to read. So instead in your package.json use a shell script defined in the project. +To use the `no-release` label you have to get a little more involved and use a shell script. We could do the `if` checks in the `package.json`, but this would get messy and hard to read very quickly. ```json { @@ -70,4 +82,4 @@ fi ## Enterprise -If you are using enterprise github `auto-release` lets you configure the github API URL that it uses. You can configure this by using the CLI option `--githubApi` or by setting the value in your `.autorc`. +If you are using enterprise github `auto-release` lets you configure the github API URL that it uses. You can configure this by using the CLI option `--githubApi` or by setting the value in your [.autorc](./autorc.md#githubApi). diff --git a/package.json b/package.json index 5ec8fa1a4..3b768d719 100644 --- a/package.json +++ b/package.json @@ -60,7 +60,7 @@ "@types/url-join": "^0.8.2", "all-contributors-cli": "^5.4.1", "husky": "^1.2.0", - "ignite": "^1.6.2", + "ignite": "^1.6.3", "jest": "~23.6.0", "lint-staged": "^8.1.0", "prettier": "^1.15.3", diff --git a/yarn.lock b/yarn.lock index 20fc33291..14566d96a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6096,10 +6096,10 @@ iferr@^0.1.5: resolved "https://registry.yarnpkg.com/iferr/-/iferr-0.1.5.tgz#c60eed69e6d8fdb6b3104a1fcbca1c192dc5b501" integrity sha1-xg7taebY/bazEEofy8ocGS3FtQE= -ignite@^1.6.2: - version "1.6.2" - resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.2.tgz#3f6b938d8d57b854332adf5ab736bd7b4dfcb934" - integrity sha512-Sl8n8amuJRe5LNl6V+0UFJA3XDpIl1zPKtDYZ4IM36Uu8gr4ACo0r81/zx/4T3rSY7nGZCHIBG9r44W6JaiUAQ== +ignite@^1.6.3: + version "1.6.3" + resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.3.tgz#e52500fee1e4ddbfc76edf9b78d409ade6dc1f62" + integrity sha512-Yq95LwC/EB5E6MhiLPmLgfP3JaZTEahgvxlarrQdNHXCSZvxTT1UFAD4HuiPHye2OahpTa8vC1/3/ntaHR62xg== dependencies: "@babel/cli" "7.0.0" "@babel/core" "7.0.0"