Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

auto-release-cli

intuit472MITdeprecated2.10.4TypeScript support: included

Package has been moved the new package name: 'auto'. Please install that instead

CLI tools to help facilitate semantic versioning based on GitHub PR labels

readme

auto-release

Generate releases based on semantic version labels on pull requests

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

CI/CD helpers for github releases. Generate releases based on semantic version labels on pull requests.

Release Features:

  • Release every merge to master based on a PR labels
  • Skip a release with the skip-release label
  • Generate a changelog with fancy headers, authors, and monorepo package association
  • Generate a GitHub release

Pull Request Interaction Features:

  • Get the labels for a PR
  • Set the status of a PR
  • Check that a pull request has a SemVer label
  • Comment on a PR with markdown

Visit the docs for more information.

Start Developing

To get set up, fork and clone the project and run the following command:

brew install automake
yarn

Linting

yarn lint

Testing

yarn test

Build/Typecheck

yarn build

Run the docs

To deploy the docs you will need to add the documentation label to your pull request.

yarn docs:watch

Contributing

Feel free to make and issue or open a pull request!

Make sure to read our code of conduct.

:rocket: Projects Using auto-release :rocket:

:star: webpack-inject-plugin - A webpack plugin to dynamically inject code into the bundle.

:star: storybook-addon-notes-github-markdown-css - Make your notes addon look like github markdown.

:star: html-webpack-insert-text-plugin - Insert text into the head or body of your HTML

:star: react-glider - A react wrapper for glider.js

:star: Ignite - Modern markdown documentation generator

:star: reaction - Artsy’s React Components

:nail_care: auto-release Badge :nail_care:

Do you project use auto-release? Then use our custom badge!

Auto Release

Auto Release

Auto Release

Auto Release

:art: Prior Art :art:

auto-release is inspired by some excellent tech that came before it.

Contributors

Thanks goes to these wonderful people (emoji key):

Adam Dierkens
Adam Dierkens

💻 📖 🤔 ⚠️
Andrew Lisowski
Andrew Lisowski

💻 📖 🤔 🚇 ⚠️
David
David

🚇
Orta
Orta

💻
Justin Bennett
Justin Bennett

🐛 💻
Alec Larson
Alec Larson

💻

This project follows the 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.

changelog

v2.10.4 (Sun Jan 20 2019)

🐛 Bug Fix

Authors: 1


v2.10.3 (Sun Jan 20 2019)

🐛 Bug Fix

Authors: 1


v2.10.2 (Sun Jan 20 2019)

⚠️ Pushed to master

Authors: 1


v2.10.1 (Sun Jan 20 2019)

⚠️ Pushed to master

Authors: 1


v2.10.0 (Sun Jan 20 2019)

🚀 Enhancement

🏠 Internal

⚠️ Pushed to master

Authors: 3


v2.9.0 (Sun Jan 20 2019)

🚀 Enhancement

Authors: 1


v2.8.0 (Sat Jan 19 2019)

🚀 Enhancement

Authors: 1


v2.7.0 (Sat Jan 19 2019)

🚀 Enhancement

Authors: 1


v2.6.2 (Sat Jan 19 2019)

🐛 Bug Fix

Authors: 1


v2.6.1 (Sat Jan 19 2019)

🐛 Bug Fix

Authors: 1


v2.6.0 (Sat Jan 19 2019)

🚀 Enhancement

🏠 Internal

Authors: 2


v2.5.8 (Fri Jan 18 2019)

📝 Documentation

Authors: 1


v2.5.7 (Fri Jan 18 2019)

🐛 Bug Fix

Authors: 1


v2.5.6 (Fri Jan 18 2019)

🐛 Bug Fix

Authors: 1


v2.5.5 (Thu Jan 17 2019)

🐛 Bug Fix

Authors: 1


v2.5.4 (Thu Jan 17 2019)

🐛 Bug Fix

Authors: 1


v2.5.3 (Thu Jan 17 2019)

🐛 Bug Fix

  • NPM Plugin: if there is no published version default to package.json version #205 (@hipstersmoothie)

🏠 Internal

Authors: 1


v2.5.2 (Thu Jan 17 2019)

🐛 Bug Fix

Authors: 1


v2.5.1 (Wed Jan 16 2019)

🐛 Bug Fix

Authors: 1


v2.5.0 (Wed Jan 16 2019)

🚀 Enhancement

Authors: 1


v2.4.2 (Wed Jan 16 2019)

🐛 Bug Fix

Authors: 1


v2.4.1 (Tue Jan 15 2019)

🐛 Bug Fix

Authors: 1


v2.4.0 (Tue Jan 15 2019)

🚀 Enhancement

Authors: 1


v2.3.2 (Tue Jan 15 2019)

🐛 Bug Fix

Authors: 1


v2.3.1 (Sun Jan 13 2019)

🐛 Bug Fix

Authors: 1


v2.3.0 (Fri Jan 11 2019)

🚀 Enhancement

🏠 Internal

📝 Documentation

Authors: 1


v2.2.0 (Wed Jan 09 2019)

🚀 Enhancement

Authors: 1


v2.1.4 (Wed Jan 09 2019)

🐛 Bug Fix

Authors: 1


v2.1.3 (Tue Jan 08 2019)

🐛 Bug Fix

🏠 Internal

Authors: 1


v2.1.2 (Tue Jan 08 2019)

🐛 Bug Fix

Authors: 1


v2.1.1 (Mon Jan 07 2019)

🐛 Bug Fix

Authors: 1


v2.1.0 (Mon Jan 07 2019)

🚀 Enhancement

Authors: 1


v2.0.4 (Mon Jan 07 2019)

🐛 Bug Fix

Authors: 1


v2.0.3 (Mon Jan 07 2019)

🐛 Bug Fix

Authors: 1


v2.0.2 (Mon Jan 07 2019)

🐛 Bug Fix

Authors: 1


v2.0.1 (Mon Jan 07 2019)

🐛 Bug Fix

Authors: 2


v2.0.0 (Mon Jan 07 2019)

💥 Breaking Change

🚀 Enhancement

🐛 Bug Fix

Authors: 3


1.0.0 (Sat Jan 05 2019)

💥 Breaking Change

🏠 Internal

📝 Documentation

Authors: 2


0.37.9 (Thu Jan 03 2019)

🐛 Bug Fix

Authors: 1


0.37.8 (Thu Jan 03 2019)

🐛 Bug Fix

Authors: 1


0.37.7 (Thu Jan 03 2019)

🐛 Bug Fix

Authors: 1


0.37.6 (Thu Jan 03 2019)

🐛 Bug Fix

Authors: 1


0.37.5 (Thu Jan 03 2019)

🐛 Bug Fix

Authors: 2


0.37.4 (Thu Jan 03 2019)

🐛 Bug Fix

Authors: 2


0.37.3 (Wed Jan 02 2019)

🐛 Bug Fix

  • Don't crash when there is no author hash in the package.json #119 (@orta)

Authors: 1


0.37.2 (Wed Jan 02 2019)

🐛 Bug Fix

🏠 Internal

Authors: 1


0.37.1 (Mon Dec 31 2018)

🐛 Bug Fix

Authors: 1


0.37.0 (Mon Dec 31 2018)

🚀 Enhancement

-

add --version flag #113 (@hipstersmoothie)

🏠 Internal

-

Add @Aghassi as a contributor #112 (@hipstersmoothie)

Authors: 1


0.36.6 (Mon Dec 31 2018)

🐛 Bug Fix

-

update deps #111 (@hipstersmoothie)

Authors: 1


0.36.5 (Mon Dec 31 2018)

🐛 Bug Fix

-

fix dry run #109 (@hipstersmoothie)

Authors: 1


0.36.4 (Mon Dec 31 2018)

🐛 Bug Fix

-

fix version parsing #110 (@hipstersmoothie)

Authors: 1


0.36.3 (Mon Dec 24 2018)


0.36.2 (Tue Dec 18 2018)


0.36.1 (Tue Dec 18 2018)

🐛 Bug Fix

Authors: 1


0.36.0 (Tue Dec 18 2018)

🚀 Enhancement

Authors: 1


0.35.0 (Mon Dec 17 2018)

🚀 Enhancement

Authors: 1


0.34.0 (Mon Dec 17 2018)

🚀 Enhancement

Authors: 1


0.33.6 (Mon Dec 17 2018)

🐛 Bug Fix

Authors: 1


0.33.5 (Mon Dec 17 2018)

🐛 Bug Fix

Authors: 1


0.33.4 (Mon Dec 17 2018)

🐛 Bug Fix

Authors: 1


0.33.3 (Sun Dec 16 2018)

🐛 Bug Fix

Authors: 1


0.33.1 (Sun Dec 16 2018)

🐛 Bug Fix

🏠 Internal

📝 Documentation

Authors: 1


0.33.0 (Sun Dec 16 2018)

🚀 Enhancement

Authors: 1


0.32.2 (Sun Dec 16 2018)

🐛 Bug Fix

📝 Documentation

Authors: 1


0.32.1 (Sun Dec 16 2018)

🐛 Bug Fix

📝 Documentation

Authors: 1


0.32.0 (Sun Dec 16 2018)

🚀 Enhancement

Authors: 1


0.31.0 (Sun Dec 16 2018)

🚀 Enhancement

Authors: 1


0.30.0 (Sun Dec 16 2018)

🚀 Enhancement

Authors: 1


0.29.0 (Sun Dec 16 2018)

🚀 Enhancement

Authors: 1


0.28.0 (Sun Dec 16 2018)

🚀 Enhancement

Authors: 1


0.27.0 (Sat Dec 15 2018)

🚀 Enhancement

📝 Documentation

Authors: 1


0.26.2 (Fri Dec 14 2018)

🐛 Bug Fix

Authors: 1


0.26.1 (Fri Dec 14 2018)

📝 Documentation

Authors: 1


0.26.0 (Fri Dec 14 2018)

🚀 Enhancement

📝 Documentation

Authors: 1


0.25.0 (Fri Dec 14 2018)

🚀 Enhancement

📝 Documentation

Authors: 1


0.24.0 (Thu Dec 13 2018)

🚀 Enhancement

Authors: 1


0.23.1 (Tue Dec 11 2018)

🐛 Bug Fix

🏠 Internal

Authors: 3


0.23.0 (Fri Dec 07 2018)

🚀 Enhancement

🏠 Internal

📝 Documentation

Authors: 1


0.22.0 (Fri Dec 07 2018)

🚀 Enhancement

Authors: 1


0.21.0 (Fri Dec 07 2018)

🚀 Enhancement

🐛 Bug Fix

Authors: 2

v0.20.20 (Fri Dec 07 2018)

🐛 Bug Fix

🏠 Internal

📝 Documentation

Authors: 1


v0.20.19 (Thu Dec 06 2018)

🏠 Internal

📝 Documentation

Authors: 1


v0.20.18 (Thu Dec 06 2018)

🐛 Bug Fix

🏠 Internal

Authors: 1


v0.20.17 (Thu Dec 06 2018)

🐛 Bug Fix

Authors: 1


v0.20.16 (Thu Dec 06 2018)

🐛 Bug Fix

🏠 Internal

Authors: 2


v0.20.15 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.10 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.10 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.10 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.10 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.10 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.10 (Wed Dec 05 2018)

🐛 Bug Fix

Authors: 1


v0.20.8 (Mon Dec 03 2018)

🐛 Bug Fix

  • Create note for PR commits without labels #101 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.7 (Sun Dec 02 2018)

🏠 Internal

  • Open Source Review #100 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.6 (Sat Nov 24 2018)

🐛 Bug Fix

  • update deps #98 (@alisowski)

📝 Documentation

  • Update README.md #95 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.5 (Thu Nov 15 2018)

🐛 Bug Fix

  • add no-verify to git commit so we skip githook (intuit-githooks) #94 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.4 (Thu Nov 15 2018)

🐛 Bug Fix

  • context is not required for pr-check #93 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.3 (Thu Nov 15 2018)

🐛 Bug Fix

  • remove all references to --use-version lerna #91 (@alisowski)
  • Last Version doesn't need to have bump calculated #90 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.3 (Thu Nov 15 2018)

🐛 Bug Fix

  • Last Version doesn't need to have bump calculated #90 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.1 (Thu Nov 15 2018)

🐛 Bug Fix

  • Better version calculating #88 (@alisowski)

📝 Documentation

  • Add Projects Using auto-release #87 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.20.0 (Wed Nov 14 2018)

🚀 Enhancement

  • using lerna version to release #85 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.19.0 (Wed Nov 14 2018)

🚀 Enhancement

  • switch to --pr to match the rest of the API #82 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.18.0 (Wed Nov 14 2018)

🚀 Enhancement

  • ability to parse multiple jira stories in a commit message #81 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.17.0 (Wed Nov 14 2018)

🚀 Enhancement

  • get all authors for a pR #76 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.16.0 (Wed Nov 14 2018)

🚀 Enhancement

  • Change all github- to auto #79 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.15.0 (Wed Nov 07 2018)

🚀 Enhancement

  • OSS Preparation #72 (@adierkens)

🐛 Bug Fix

  • filter out null values from args so they dont override the config #74 (@alisowski)

📝 Documentation

  • update readme #73 (@alisowski)

Authors: 2

  • Adam Dierkens (@adierkens)
  • Andrew Lisowski (@alisowski)

v0.14.0 (Mon Nov 05 2018)

🚀 Enhancement

  • add dry run to changelog #70 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.13.0 (Mon Nov 05 2018)

🚀 Enhancement

  • Verbose Log #69 (@alisowski)

🏠 Internal

  • Update Dependancies + Remove extra files #68 (@alisowski)

📝 Documentation

  • Add CircleCI setup #67 (@alisowski)
  • Update README.md #66 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.12.8 (Tue Oct 30 2018)

🐛 Bug Fix

  • debug info #65 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.12.6 (Tue Oct 30 2018)

🏠 Internal

  • fix version path in release script #64 (@alisowski)
  • Use github-version to calculate version instead in release.sh #62 (@alisowski)

📝 Documentation

  • add important setup line #63 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

vnull (Tue Oct 30 2018)


vnull (Tue Oct 30 2018)

🐛 Bug Fix

  • prefix the github release too #58 (@alisowski)

🏠 Internal

  • remove token and actually run the thing #59 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.12.4 (Tue Oct 30 2018)

🐛 Bug Fix

  • prefix the github release too #58 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.12.3 (Tue Oct 30 2018)


v0.12.2 (Tue Oct 30 2018)

🐛 Bug Fix

  • use pr check #57 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.12.1 (Tue Oct 30 2018)


v0.12.0 (Tue Oct 30 2018)

🚀 Enhancement

    • Monorepo aware changelogs #55 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.11.0 (Tue Oct 30 2018)

🚀 Enhancement

  • Rely on package.json less #54 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.6 (Fri Oct 26 2018)

🐛 Bug Fix

  • onlyPublishWIthReleaseLabel default value bug #53 (@alisowski)
  • fix no version script #51 (@alisowski)
  • latest commit is actually first #50 (@alisowski)

📝 Documentation

  • add more docs #52 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.5 (Fri Oct 26 2018)

🐛 Bug Fix

  • add missing bin scripts #48 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.4 (Fri Oct 26 2018)

📝 Documentation

  • re-org readme #49 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.3 (Fri Oct 26 2018)

🐛 Bug Fix

  • must prefix release if needed. #47 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.2 (Fri Oct 26 2018)

🐛 Bug Fix

  • Gugs #46 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.1 (Fri Oct 26 2018)

🐛 Bug Fix

  • Update README.md #45 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.10.0 (Fri Oct 26 2018)

🚀 Enhancement

  • Link to PR in changelog #42 (@alisowski)

🐛 Bug Fix

  • just use use version to get it right? #44 (@alisowski)
  • Put changelog generation in correct place #43 (@alisowski)
  • add more logging #41 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.9.0 (Fri Oct 26 2018)

🚀 Enhancement

  • Link to PR in changelog #42 (@alisowski)

🐛 Bug Fix

  • just use use version to get it right? #44 (@alisowski)
  • Put changelog generation in correct place #43 (@alisowski)
  • add more logging #41 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.8.0 (Fri Oct 26 2018)

🚀 Enhancement

  • Link to PR in changelog #42 (@alisowski)

🐛 Bug Fix

  • Put changelog generation in correct place #43 (@alisowski)
  • add more logging #41 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.6.2 (Fri Oct 26 2018)

🐛 Bug Fix

  • add more logging #41]()[@alisowski

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.6.1 (Fri Oct 26 2018)

🐛 Bug Fix

  • add more logging #41 (@alisowski)

Authors: 1

  • Andrew Lisowski (@alisowski)

v0.6.0 (Fri Oct 26 2018)

🚀 Enhancement

  • add release script #34 (@adierkens)
  • github-comment #33 (@alisowski)
  • add authors to changelog #22 (@alisowski)
  • Version and Author Bug #40 (@alisowski)

🐛 Bug Fix

  • change the name #39 (@alisowski)

Authors: 2

  • Adam Dierkens (@adierkens)
  • Andrew Lisowski (@alisowski)