diff --git a/.all-contributorsrc b/.all-contributorsrc index 808da1926..db3b33a3e 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,5 +1,5 @@ { - "projectName": "auto-release", + "projectName": "auto", "projectOwner": "intuit", "repoType": "github", "repoHost": "https://github.com", diff --git a/.circleci/config.yml b/.circleci/config.yml index db274a0ed..309dd6029 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,7 +1,7 @@ version: 2.1 defaults: &defaults - working_directory: ~/auto-release + working_directory: ~/auto docker: - image: circleci/node:8.14-browsers environment: @@ -13,12 +13,12 @@ aliases: keys: # Find a cache corresponding to this specific package.json checksum # when this file is changed, this key will fail - - auto-release-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }} - - auto-release-{{ checksum "yarn.lock" }} + - auto-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }} + - auto-{{ checksum "yarn.lock" }} # Find the most recent cache used from any branch - - auto-release- + - auto- - &save-cache - key: auto-release-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }} + key: auto-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }} paths: - ~/.cache/yarn - node_modules @@ -51,14 +51,14 @@ jobs: <<: *defaults steps: - attach_workspace: - at: ~/auto-release + at: ~/auto - run: *lint test: <<: *defaults steps: - attach_workspace: - at: ~/auto-release + at: ~/auto - run: *test - run: name: Send CodeCov Results @@ -68,7 +68,7 @@ jobs: <<: *defaults steps: - attach_workspace: - at: ~/auto-release + at: ~/auto - run: name: Build command: yarn build @@ -84,7 +84,7 @@ jobs: <<: *defaults steps: - attach_workspace: - at: ~/auto-release + at: ~/auto - run: mkdir ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" > ~/.ssh/config - run: name: Release @@ -94,7 +94,7 @@ jobs: <<: *defaults steps: - attach_workspace: - at: ~/auto-release + at: ~/auto - run: name: Publish Docs command: yarn docs:publish diff --git a/README.md b/README.md index ae0da9d43..1bc1ca325 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@
-

auto-release

+

auto

Generate releases based on semantic version labels on pull requests

-
CircleCI Codecov npm All Contributors npm Auto Release code style: prettier
+
CircleCI Codecov npm All Contributors npm Auto Release code style: prettier

@@ -25,7 +25,7 @@ Pull Request Interaction Features: - Check that a pull request has a SemVer label - Comment on a PR with markdown -Visit [the docs](https://intuit.github.io/auto-release/) for more information. +Visit [the docs](https://intuit.github.io/auto/) for more information. ## Start Developing @@ -64,11 +64,11 @@ yarn docs:watch ## Contributing -Feel free to make and [issue](https://github.com/intuit/auto-release/issues) or open a [pull request](https://github.com/intuit/auto-release/pulls)! +Feel free to make and [issue](https://github.com/intuit/auto/issues) or open a [pull request](https://github.com/intuit/auto/pulls)! Make sure to read our [code of conduct](./CODE_OF_CONDUCT.md). -## :rocket: Projects Using `auto-release` :rocket: +## :rocket: Projects Using `auto` :rocket: :star: [webpack-inject-plugin](https://github.com/adierkens/webpack-inject-plugin) - A webpack plugin to dynamically inject code into the bundle. @@ -82,21 +82,21 @@ Make sure to read our [code of conduct](./CODE_OF_CONDUCT.md). :star: [reaction](https://github.com/artsy/reaction) - Artsy’s React Components -## :nail_care: `auto-release` Badge :nail_care: +## :nail_care: `auto` Badge :nail_care: -Do you project use `auto-release`? Then use our custom badge! +Do you project use `auto`? Then use our custom badge! -[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto)](https://github.com/intuit/auto-release) +[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto)](https://github.com/intuit/auto) -[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto-release) +[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto) -[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&style=for-the-badge)](https://github.com/intuit/auto-release) +[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&style=for-the-badge)](https://github.com/intuit/auto) -[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto-release) +[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto) ## :art: Prior Art :art: -`auto-release` is inspired by some excellent tech that came before it. +`auto` is inspired by some excellent tech that came before it. - [github-semantic-version](https://github.com/ericclemmons/github-semantic-version) - Automated semantic version releases powered by Github Issues. - [lerna-changelog](https://github.com/lerna/lerna-changelog) - πŸ“– PR-based changelog generator with monorepo support @@ -107,8 +107,8 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds -| [Adam Dierkens
Adam Dierkens](https://adamdierkens.com)
[πŸ’»](https://github.com/intuit/auto-release/commits?author=adierkens "Code") [πŸ“–](https://github.com/intuit/auto-release/commits?author=adierkens "Documentation") [πŸ€”](#ideas-adierkens "Ideas, Planning, & Feedback") [⚠️](https://github.com/intuit/auto-release/commits?author=adierkens "Tests") | [Andrew Lisowski
Andrew Lisowski](http://hipstersmoothie.com)
[πŸ’»](https://github.com/intuit/auto-release/commits?author=hipstersmoothie "Code") [πŸ“–](https://github.com/intuit/auto-release/commits?author=hipstersmoothie "Documentation") [πŸ€”](#ideas-hipstersmoothie "Ideas, Planning, & Feedback") [πŸš‡](#infra-hipstersmoothie "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/intuit/auto-release/commits?author=hipstersmoothie "Tests") | [David
David](https://github.com/Aghassi)
[πŸš‡](#infra-Aghassi "Infrastructure (Hosting, Build-Tools, etc)") | [Orta
Orta](http://orta.io)
[πŸ’»](https://github.com/intuit/auto-release/commits?author=orta "Code") | [Justin Bennett
Justin Bennett](https://github.com/zephraph)
[πŸ›](https://github.com/intuit/auto-release/issues?q=author%3Azephraph "Bug reports") [πŸ’»](https://github.com/intuit/auto-release/commits?author=zephraph "Code") | [Alec Larson
Alec Larson](https://twitter.com/alecdotbiz)
[πŸ’»](https://github.com/intuit/auto-release/commits?author=aleclarson "Code") | -| :---: | :---: | :---: | :---: | :---: | :---: | +| [Adam Dierkens
Adam Dierkens](https://adamdierkens.com)
[πŸ’»](https://github.com/intuit/auto/commits?author=adierkens "Code") [πŸ“–](https://github.com/intuit/auto/commits?author=adierkens "Documentation") [πŸ€”](#ideas-adierkens "Ideas, Planning, & Feedback") [⚠️](https://github.com/intuit/auto/commits?author=adierkens "Tests") | [Andrew Lisowski
Andrew Lisowski](http://hipstersmoothie.com)
[πŸ’»](https://github.com/intuit/auto/commits?author=hipstersmoothie "Code") [πŸ“–](https://github.com/intuit/auto/commits?author=hipstersmoothie "Documentation") [πŸ€”](#ideas-hipstersmoothie "Ideas, Planning, & Feedback") [πŸš‡](#infra-hipstersmoothie "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/intuit/auto/commits?author=hipstersmoothie "Tests") | [David
David](https://github.com/Aghassi)
[πŸš‡](#infra-Aghassi "Infrastructure (Hosting, Build-Tools, etc)") | [Orta
Orta](http://orta.io)
[πŸ’»](https://github.com/intuit/auto/commits?author=orta "Code") | [Justin Bennett
Justin Bennett](https://github.com/zephraph)
[πŸ›](https://github.com/intuit/auto/issues?q=author%3Azephraph "Bug reports") [πŸ’»](https://github.com/intuit/auto/commits?author=zephraph "Code") | [Alec Larson
Alec Larson](https://twitter.com/alecdotbiz)
[πŸ’»](https://github.com/intuit/auto/commits?author=aleclarson "Code") | +| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | diff --git a/docs/home.md b/docs/home.md index bca16de3d..835b18eb7 100644 --- a/docs/home.md +++ b/docs/home.md @@ -8,7 +8,7 @@ ## Adding automated releases shouldn't be hard or require changing your workflow /.no-link .has-text-purple .has-text-centered\ -`auto-release` makes automating releases for your open source project as simple as labels to pull requests. Releasing often means being confident in your releases. /.has-text-centered\ +`auto` makes automating releases for your open source project as simple as labels to pull requests. Releasing often means being confident in your releases. /.has-text-centered\ ||| row has-text-centered wide diff --git a/docs/pages/auto-changelog.md b/docs/pages/auto-changelog.md index 026f8e0aa..fec036873 100644 --- a/docs/pages/auto-changelog.md +++ b/docs/pages/auto-changelog.md @@ -26,7 +26,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-comment.md b/docs/pages/auto-comment.md index 6f9166459..e3a663b48 100644 --- a/docs/pages/auto-comment.md +++ b/docs/pages/auto-comment.md @@ -26,7 +26,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-init.md b/docs/pages/auto-init.md index 62419a99c..77adc0acb 100644 --- a/docs/pages/auto-init.md +++ b/docs/pages/auto-init.md @@ -1,6 +1,6 @@ # 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` 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` @@ -38,7 +38,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package.json --owner string The owner of the GitHub repo. Defaults to reading from the package.json --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-label.md b/docs/pages/auto-label.md index e2d0be19b..b57177aac 100644 --- a/docs/pages/auto-label.md +++ b/docs/pages/auto-label.md @@ -17,7 +17,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples @@ -28,4 +28,4 @@ Examples Running `auto label` without the PR number enables it to run in master after a PR has been merged. You can use these labels to automate more things in your merge build pipeline other than the release. -`auto-release` the project uses this to only deploy the documentation when the last merged PR has a `documentation` label. +`auto` the project uses this to only deploy the documentation when the last merged PR has a `documentation` label. diff --git a/docs/pages/auto-pr-check.md b/docs/pages/auto-pr-check.md index bef55b0a2..a3f63bedf 100644 --- a/docs/pages/auto-pr-check.md +++ b/docs/pages/auto-pr-check.md @@ -28,7 +28,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-pr.md b/docs/pages/auto-pr.md index 51be6868b..8b0c32784 100644 --- a/docs/pages/auto-pr.md +++ b/docs/pages/auto-pr.md @@ -25,7 +25,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-release.md b/docs/pages/auto-release.md index d4c97527f..110af8028 100644 --- a/docs/pages/auto-release.md +++ b/docs/pages/auto-release.md @@ -44,7 +44,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-shipit.md b/docs/pages/auto-shipit.md index 8668b11fd..23aec6066 100644 --- a/docs/pages/auto-shipit.md +++ b/docs/pages/auto-shipit.md @@ -1,6 +1,6 @@ # `auto shipit` -Run the full auto-release project. Will detect if in a lerna project and publish accordingly. +Run the full `auto` release pipeline. Will detect if in a lerna project and publish accordingly. ```sh auto shipit @@ -24,7 +24,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/auto-version.md b/docs/pages/auto-version.md index 293dadc3b..da1ced051 100644 --- a/docs/pages/auto-version.md +++ b/docs/pages/auto-version.md @@ -18,7 +18,7 @@ Global Options --repo string The repo to set the status on. Defaults to looking in the package definition for the platform --owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform --github-api string GitHub API to use - --plugins string[] Plugins to load auto-release with. (defaults to just npm) + --plugins string[] Plugins to load auto with. (defaults to just npm) Examples diff --git a/docs/pages/autorc.md b/docs/pages/autorc.md index 532929e58..fff21ce8b 100644 --- a/docs/pages/autorc.md +++ b/docs/pages/autorc.md @@ -124,7 +124,7 @@ To include Jira story information in your changelogs you must include a URL to y ### githubApi -If you are using enterprise github `auto-release` lets you configure the github API URL that it uses. +If you are using enterprise github, `auto` lets you configure the github API URL that it uses. ```json { diff --git a/docs/pages/circleci.md b/docs/pages/circleci.md index 6e68840b4..7b6736e12 100644 --- a/docs/pages/circleci.md +++ b/docs/pages/circleci.md @@ -6,7 +6,7 @@ The following config declares the `release` job and uses it in the `build_and_re version: 2 defaults: &defaults - working_directory: ~/auto-release-test + working_directory: ~/auto docker: - image: circleci/node:latest-browsers @@ -17,7 +17,7 @@ jobs: <<: *defaults steps: - attach_workspace: - at: ~/auto-release-test + at: ~/auto - run: name: Release command: npm run release diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md index 727a55954..e88be45df 100644 --- a/docs/pages/getting-started.md +++ b/docs/pages/getting-started.md @@ -1,14 +1,14 @@ # Getting Started -Before we do anything we must first install `auto-release-cli` as a dev dependency. +Before we do anything we must first install `auto` as a dev dependency. ```sh -yarn add -D auto-release-cli +yarn add -D auto ``` ## 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 `--github-api`, by setting the value in your [.autorc](./autorc.md#githubApi), or during `auto init`. +If you are using enterprise github `auto` lets you configure the github API URL that it uses. You can configure this by using the CLI option `--github-api`, by setting the value in your [.autorc](./autorc.md#githubApi), or during `auto init`. ### Project already published @@ -23,11 +23,11 @@ git push --tags Then on GitHub go to your project's releases and click `Draft a new release`. In the `Tag version` field enter the version number you just tagged and click `Publish release`. -Now your github project is set up to use `auto-release`. +Now your github project is set up to use `auto`. ## Configuration -Getting started with `auto-release` is super easy. +Getting started with `auto` is super easy. 1. `auto init` (optional) 2. `auto create-labels` @@ -36,11 +36,11 @@ Getting started with `auto-release` is super easy. ### 1. Initialize Options -Initialize all options and configure label text. If this is not run then `auto-release` will use the default configuration. This command will produce and `.autorc`, this contains advanced configuration and might not be needed. +Initialize all options and configure label text. If this is not run then `auto` will use the default configuration. This command will produce and `.autorc`, this contains advanced configuration and might not be needed. ### 2. Labels -After that, you need to set up the labels on your github project. The types of labels that `auto-release` uses are: +After that, you need to set up the labels on your github project. The types of labels that `auto` uses are: - 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) @@ -67,7 +67,7 @@ NPM_TOKEN=PUBLISH_TOKEN ### 4. Script -`auto-release` is written so that each tool it exposes is useful in isolation. It also provides workflows for those who don't care about the details of each tool and just want their code released. +`auto` is written so that each tool it exposes is useful in isolation. It also provides workflows for those who don't care about the details of each tool and just want their code released. #### Quick Setup diff --git a/docs/pages/introduction.md b/docs/pages/introduction.md index b71158b60..47dce0739 100644 --- a/docs/pages/introduction.md +++ b/docs/pages/introduction.md @@ -1,6 +1,6 @@ ![Markdown](../images/auto.gif)/.header-image\ -# :rocket: auto-release :rocket:/.has-text-centered\ +# :rocket: auto :rocket:/.has-text-centered\ CI/CD helpers for github releases. Generate releases based on semantic version labels on pull requests. diff --git a/docs/pages/pr-interaction.md b/docs/pages/pr-interaction.md index cddf2011f..cf04afdb5 100644 --- a/docs/pages/pr-interaction.md +++ b/docs/pages/pr-interaction.md @@ -1,6 +1,6 @@ # Pull Request Interaction -`auto-release` also includes a variety of PR interaction tools to update PRs from the CI. You can use these tools in various ways to make your PR validation process much more customized. +`auto` also includes a variety of PR interaction tools to update PRs from the CI. You can use these tools in various ways to make your PR validation process much more customized.
diff --git a/docs/pages/publishing.md b/docs/pages/publishing.md index 38d098e2b..676825d57 100644 --- a/docs/pages/publishing.md +++ b/docs/pages/publishing.md @@ -1,6 +1,6 @@ # Publishing -`auto-release`'s main use it to automate the release process for your project This can be broken down into three core steps: +`auto`'s main use it to automate the release process for your project This can be broken down into three core steps: ```text pre: (optional) Check if new version @@ -10,4 +10,4 @@ pre: (optional) Check if new version 3. Generate github release notes ``` -`auto-release` makes no assumptions about your publishing process. Each tool is a function that can be run in isolation and only does one thing really well. For instance, you could just use `auto changelog` to generate the changelog and nothing else or use `auto version` to calculate just the semver bump. +`auto` makes no assumptions about your publishing process. Each tool is a function that can be run in isolation and only does one thing really well. For instance, you could just use `auto changelog` to generate the changelog and nothing else or use `auto version` to calculate just the semver bump. diff --git a/docs/pages/troubleshooting.md b/docs/pages/troubleshooting.md index ffa895e5c..78f85a1ec 100644 --- a/docs/pages/troubleshooting.md +++ b/docs/pages/troubleshooting.md @@ -2,11 +2,11 @@ ## Error: Can't find a GitHub token to use -You must set a `GH_TOKEN` for `auto-release` to work. Make sure to add your `NPM_TOKEN` while you're at it. +You must set a `GH_TOKEN` for `auto` to work. Make sure to add your `NPM_TOKEN` while you're at it. ## npm ERR! Git working directory not clean -To version and publish you cannot have any changes in the git repo during publish. This means that if you build some files before release that aren't gitignored `auto` will fail to continue. To fix this either add those `dist` files to your `.gitignore` or commit them somehow before the relese. +To version and publish you cannot have any changes in the git repo during publish. This means that if you build some files before release that aren't git-ignored `auto` will fail to continue. To fix this either add those `dist` files to your `.gitignore` or commit them somehow before the release. ## npm ERR! need auth auth required for publishing @@ -52,18 +52,18 @@ This means that you do not have a repository set in your package.json. Add somet { "repository": { "type": "git", - "url": "https://github.com/intuit/auto-release" + "url": "https://github.com/intuit/auto" }, // or simply - "repository": "intuit/auto-release" + "repository": "intuit/auto" } ``` -## How do I auto-release a fork of another repo? +## How do I auto a fork of another repo? -If auto-release doesn't find a last release it will default to the first commit for version calculation (and a log of other things). If you have forked a repo, you fork all the merge commit messages as well. This confuses `auto-release` since it will look for those pull requests in your fork and not the main one. +If auto doesn't find a last release it will default to the first commit for version calculation (and a log of other things). If you have forked a repo, you fork all the merge commit messages as well. This confuses `auto` since it will look for those pull requests in your fork and not the main one. -To remedy this first tag your first commit in the fork with your first version. If the tags from the original repo are still in your repo you should just bump that version. This will let `auto-release` ignore all the old merge commits. +To remedy this first tag your first commit in the fork with your first version. If the tags from the original repo are still in your repo you should just bump that version. This will let `auto` ignore all the old merge commits. ::: message is-warning :warning: You must also match this new tag version in your package.json @@ -74,4 +74,4 @@ To remedy this first tag your first commit in the fork with your first version. git tag v2.10.1 ``` -Then on GitHub go to your project, click release, then draft a new release. Select the tag you just published and `publish release`. Now auto-release will be able to use the correct version and git log! +Then on GitHub go to your project, click release, then draft a new release. Select the tag you just published and `publish release`. Now auto will be able to use the correct version and git log! diff --git a/docs/pages/writing-plugins.md b/docs/pages/writing-plugins.md index 2513eeb59..ecea97072 100644 --- a/docs/pages/writing-plugins.md +++ b/docs/pages/writing-plugins.md @@ -8,7 +8,7 @@ A plugin definition is: - a constructor where you can load plugin specific config ```ts -import { AutoRelease, IPlugin } from 'auto-release-cli'; +import { AutoRelease, IPlugin } from 'auto'; export default class TestPlugin implements IPlugin { private readonly config: any; @@ -28,7 +28,7 @@ export default class TestPlugin implements IPlugin { In the constructor you have access to any plugin specific config provided in the `.autorc`. It might be useful to write a more type-safe interface for your config. ```ts -import { AutoRelease, IPlugin } from 'auto-release-cli'; +import { AutoRelease, IPlugin } from 'auto'; interface ITestPluginConfig { foo?: string; diff --git a/package.json b/package.json index 155b05406..8485d915a 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "auto-release-cli", + "name": "auto", "description": "CLI tools to help facilitate semantic versioning based on GitHub PR labels", "version": "2.10.4", "main": "dist/main.js", @@ -16,7 +16,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/intuit/auto-release" + "url": "https://github.com/intuit/auto" }, "files": [ "dist" @@ -134,11 +134,11 @@ ] }, "ignite": { - "title": "auto-release", - "baseURL": "/auto-release", + "title": "auto", + "baseURL": "/auto", "logo": "logo.gif", "bulmaTheme": "materia", - "githubURL": "https://github.com/intuit/auto-release", + "githubURL": "https://github.com/intuit/auto", "customHead": "", "favicon": "favicon.png" } diff --git a/src/__tests__/__snapshots__/auto-release.test.ts.snap b/src/__tests__/__snapshots__/auto.test.ts.snap similarity index 100% rename from src/__tests__/__snapshots__/auto-release.test.ts.snap rename to src/__tests__/__snapshots__/auto.test.ts.snap diff --git a/src/__tests__/__snapshots__/changelog.test.ts.snap b/src/__tests__/__snapshots__/changelog.test.ts.snap index 9c9cf5b26..3692af122 100644 --- a/src/__tests__/__snapshots__/changelog.test.ts.snap +++ b/src/__tests__/__snapshots__/changelog.test.ts.snap @@ -3,7 +3,7 @@ exports[`Hooks author 1`] = ` "#### πŸ› Bug Fix -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (:heart: Adam Dierkens/adam@dierkens.com :heart:) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (:heart: Adam Dierkens/adam@dierkens.com :heart:) #### Authors: 1 @@ -12,7 +12,7 @@ exports[`Hooks author 1`] = ` exports[`Hooks title 1`] = ` ":heart: πŸ› Bug Fix :heart: -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (adam@dierkens.com) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (adam@dierkens.com) #### Authors: 1 @@ -22,7 +22,7 @@ exports[`Hooks title 1`] = ` exports[`generateReleaseNotes should combine pr w/no label and labelled pr 1`] = ` "#### πŸ› Bug Fix -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (adam@dierkens.com) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (adam@dierkens.com) - Third (adam@dierkens.com) #### Authors: 1 @@ -33,7 +33,7 @@ exports[`generateReleaseNotes should combine pr w/no label and labelled pr 1`] = exports[`generateReleaseNotes should create note for JIRA commits 1`] = ` "#### πŸ’₯ Breaking Change -- [PLAYA-5052](https://jira.custom.com/browse/PLAYA-5052): Some Feature [#12345](https://github.custom.com/foobar/auto-release/pull/12345) (adam@dierkens.com) +- [PLAYA-5052](https://jira.custom.com/browse/PLAYA-5052): Some Feature [#12345](https://github.custom.com/foobar/auto/pull/12345) (adam@dierkens.com) #### πŸ› Bug Fix @@ -41,7 +41,7 @@ exports[`generateReleaseNotes should create note for JIRA commits 1`] = ` #### 🏠 Internal -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (adam@dierkens.com) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (adam@dierkens.com) #### Authors: 1 @@ -51,7 +51,7 @@ exports[`generateReleaseNotes should create note for JIRA commits 1`] = ` exports[`generateReleaseNotes should create note for PR commits 1`] = ` "#### πŸš€ Enhancement -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (adam@dierkens.com) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (adam@dierkens.com) #### Authors: 1 @@ -61,7 +61,7 @@ exports[`generateReleaseNotes should create note for PR commits 1`] = ` exports[`generateReleaseNotes should create note for PR commits without labels 1`] = ` "#### πŸ› Bug Fix -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (adam@dierkens.com) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (adam@dierkens.com) #### Authors: 1 @@ -81,7 +81,7 @@ exports[`generateReleaseNotes should create note for jira commits without labels exports[`generateReleaseNotes should include PR-less commits as patches 1`] = ` "#### πŸš€ Enhancement -- First Feature [#1235](https://github.custom.com/foobar/auto-release/pull/1235) (adam@dierkens.com) +- First Feature [#1235](https://github.custom.com/foobar/auto/pull/1235) (adam@dierkens.com) #### ⚠️ Pushed to master @@ -95,14 +95,14 @@ exports[`generateReleaseNotes should include PR-less commits as patches 1`] = ` exports[`generateReleaseNotes should omit authors with invalid email addresses 1`] = ` "#### πŸš€ Enhancement -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234)" +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234)" `; exports[`generateReleaseNotes should use only email if author name doesn't exist 1`] = ` "#### πŸ› Bug Fix -- Another Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) (adam@dierkens.com) -- One Feature [#1235](https://github.custom.com/foobar/auto-release/pull/1235) +- Another Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) (adam@dierkens.com) +- One Feature [#1235](https://github.custom.com/foobar/auto/pull/1235) #### Authors: 1 @@ -112,7 +112,7 @@ exports[`generateReleaseNotes should use only email if author name doesn't exist exports[`generateReleaseNotes should use username if present 1`] = ` "#### πŸš€ Enhancement -- Some Feature [#1234](https://github.custom.com/foobar/auto-release/pull/1234) ([@adam](https://github.custom.com/adam)) +- Some Feature [#1234](https://github.custom.com/foobar/auto/pull/1234) ([@adam](https://github.custom.com/adam)) #### Authors: 1 diff --git a/src/__tests__/auto-release-env.test.ts b/src/__tests__/auto-env.test.ts similarity index 91% rename from src/__tests__/auto-release-env.test.ts rename to src/__tests__/auto-env.test.ts index 4a5c611ae..6a3c49817 100644 --- a/src/__tests__/auto-release-env.test.ts +++ b/src/__tests__/auto-env.test.ts @@ -1,4 +1,4 @@ -import AutoRelease from '../auto-release'; +import AutoRelease from '../auto'; jest.mock('fs', () => ({ readFileSync: () => 'FOO="test value"', diff --git a/src/__tests__/auto-release.test.ts b/src/__tests__/auto.test.ts similarity index 99% rename from src/__tests__/auto-release.test.ts rename to src/__tests__/auto.test.ts index 57fbf1ea2..072e1410a 100644 --- a/src/__tests__/auto-release.test.ts +++ b/src/__tests__/auto.test.ts @@ -1,4 +1,4 @@ -import AutoRelease from '../auto-release'; +import AutoRelease from '../auto'; import { IPRCommandOptions } from '../cli/args'; import { SEMVER } from '../main'; import { dummyLog } from '../utils/logger'; diff --git a/src/__tests__/changelog.test.ts b/src/__tests__/changelog.test.ts index 31f1fc6bc..0d77090b8 100644 --- a/src/__tests__/changelog.test.ts +++ b/src/__tests__/changelog.test.ts @@ -6,8 +6,8 @@ import makeCommitFromMsg from './make-commit-from-msg'; const testOptions = (): IGenerateReleaseNotesOptions => ({ owner: 'foobar', - repo: 'auto-release', - baseUrl: 'https://github.custom.com/foobar/auto-release', + repo: 'auto', + baseUrl: 'https://github.custom.com/foobar/auto', jira: 'https://jira.custom.com/browse', versionLabels: defaultLabels, changelogTitles: defaultChangelogTitles diff --git a/src/auto-rc.json b/src/auto-rc.json index a93468e1a..ba54ae56d 100644 --- a/src/auto-rc.json +++ b/src/auto-rc.json @@ -1,5 +1,5 @@ { - "title": "auto-release-rc", + "title": "auto-rc", "type": "object", "properties": { "jira": { diff --git a/src/auto-release.ts b/src/auto.ts similarity index 99% rename from src/auto-release.ts rename to src/auto.ts index 7777c1bc3..f1af5c73f 100644 --- a/src/auto-release.ts +++ b/src/auto.ts @@ -141,10 +141,7 @@ export default class AutoRelease { rawConfig = merge(rawConfig, this.loadExtendConfig(rawConfig.extends)); } - this.logger.verbose.success( - 'Loaded `auto-release` with config:', - rawConfig - ); + this.logger.verbose.success('Loaded `auto` with config:', rawConfig); this.semVerLabels = defaultLabels; diff --git a/src/cli/args.ts b/src/cli/args.ts index 2e88436b6..3201a7346 100644 --- a/src/cli/args.ts +++ b/src/cli/args.ts @@ -35,7 +35,7 @@ const version = { name: 'version', alias: 'V', type: Boolean, - description: "Display auto-release-cli's version" + description: "Display auto's version" }; const mainDefinitions = [ @@ -91,7 +91,7 @@ const defaultOptions = [ name: 'plugins', type: String, multiple: true, - description: 'Plugins to load auto-release with. (defaults to just npm)', + description: 'Plugins to load auto with. (defaults to just npm)', group: 'misc' } ]; @@ -378,7 +378,8 @@ const commands: ICommand[] = [ }, { name: 'shipit', - summary: 'Run the full auto-release project. Detects if in a lerna project', + summary: + 'Run the full `auto` release pipeline. Detects if in a lerna project', examples: ['{green $} auto shipit'], options: [...defaultOptions, dryRun] } diff --git a/src/main.ts b/src/main.ts index 8a491dd32..652d86fbc 100644 --- a/src/main.ts +++ b/src/main.ts @@ -1,6 +1,6 @@ #!/usr/bin/env node -import AutoRelease from './auto-release'; +import AutoRelease from './auto'; import { ArgsType, @@ -78,6 +78,6 @@ export default async function main(args: ArgsType) { export { ILogger } from './utils/logger'; export { IPlugin } from './utils/load-plugins'; -export { default as AutoRelease } from './auto-release'; +export { default as AutoRelease } from './auto'; export { default as SEMVER } from './semver'; export { default as execPromise } from './utils/exec-promise'; diff --git a/src/utils/make-hooks.ts b/src/utils/make-hooks.ts index b5537a525..a478ae10d 100644 --- a/src/utils/make-hooks.ts +++ b/src/utils/make-hooks.ts @@ -4,7 +4,7 @@ import { AsyncSeriesWaterfallHook, SyncHook } from 'tapable'; -import { IAutoHooks } from '../auto-release'; +import { IAutoHooks } from '../auto'; import { IChangelogHooks } from '../changelog'; import { ILogParseHooks } from '../log-parse'; import { IReleaseHooks } from '../release';