| 1 | # auto CLI
|
| 2 |
|
| 3 | Generate releases based on semantic version labels on pull requests
|
| 4 |
|
| 5 | ```sh
|
| 6 | $ auto -h
|
| 7 |
|
| 8 | Synopsis
|
| 9 |
|
| 10 | $ auto <command> <options>
|
| 11 |
|
| 12 | Setup Commands
|
| 13 |
|
| 14 | init Interactive setup for most configurable options
|
| 15 | create-labels Create your project's labels on github. If labels exist it will update them.
|
| 16 |
|
| 17 | Release Commands
|
| 18 |
|
| 19 | version Get the semantic version bump for the given changes.
|
| 20 | changelog Prepend release notes to 'CHANGELOG.md'
|
| 21 | release Auto-generate a github release
|
| 22 | shipit Run the full `auto` release pipeline. Detects if in a lerna project.
|
| 23 |
|
| 24 | 1. call from base branch -> latest version released
|
| 25 | 2. call from PR in CI -> canary version released
|
| 26 | 3. call locally when not on base branch -> canary version released
|
| 27 | canary Make a canary release of the project. Useful on PRs. If ran locally, `canary` will release a canary version for
|
| 28 | your current git HEAD.
|
| 29 |
|
| 30 | 1. In PR: 1.2.3-canary.123.0 + add version to PR body
|
| 31 | 2. Locally: 1.2.3-canary.1810cfd
|
| 32 |
|
| 33 | Pull Request Interaction Commands
|
| 34 |
|
| 35 | label Get the labels for a pull request
|
| 36 | pr-check Check that a pull request has a SemVer label
|
| 37 | pr Set the status on a PR commit
|
| 38 | comment Comment on a pull request with a markdown message. Each comment has a context, and each context only has one
|
| 39 | comment.
|
| 40 | pr-body Update the body of a PR with a message. Appends to PR and will not overwrite user content. Each comment has a
|
| 41 | context, and each context only has one comment.
|
| 42 |
|
| 43 | Global Options
|
| 44 |
|
| 45 | -V, --version Display auto's version
|
| 46 | -h, --help Display the help output for the command
|
| 47 | -v, --verbose Show some more logs
|
| 48 | -w, --very-verbose Show a lot more logs
|
| 49 | --repo string The repo to set the status on. Defaults to looking in the package definition
|
| 50 | for the platform
|
| 51 | --owner string The owner of the GitHub repo. Defaults to reading from the package definition
|
| 52 | for the platform
|
| 53 | --github-api string GitHub API to use
|
| 54 | --plugins string[] Plugins to load auto with. (defaults to just npm)
|
| 55 | ```
|