Need help with auto?
Click the β€œchat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

intuit
1.2K Stars 121 Forks MIT License 5.7K Commits 57 Opened issues

Description

Generate releases based on semantic version labels on pull requests.

Services available

!
?

Need anything else?

Contributors list

# 10,238
TypeScr...
Storybo...
newtab
jira
3242 commits
# 181
nextjs
postman...
graphql...
angular...
63 commits
# 52,634
coffees...
media-q...
codebas...
Koa
58 commits
# 355,701
slack
TypeScr...
jira
CSS
30 commits
# 331,971
jira
add-on
Storybo...
React
21 commits
# 460,196
slack
TypeScr...
JavaScr...
jira
18 commits
# 69,128
C
C++
semanti...
release...
16 commits
# 483,773
slack
TypeScr...
JavaScr...
jira
16 commits
# 101,028
SQL
flyway
aurora
sqlserv...
13 commits
# 465,152
HTML
R
slack
jira
8 commits
# 17,977
PHP
netflix
amazon-...
aws-s3
7 commits
# 8,688
JavaScr...
Gulp
pattern...
atomic-...
7 commits
# 85,804
ssh-age...
c-plus-...
jira
browser...
6 commits
# 195,318
C#
HTML
slack
jira
6 commits
# 284,274
HTML
CSS
jira
React
5 commits
# 85,107
reactjs
jira
C#
c-sharp
5 commits
# 594,901
slack
TypeScr...
JavaScr...
jira
5 commits
# 615,304
slack
TypeScr...
JavaScr...
jira
4 commits
# 612,915
slack
TypeScr...
JavaScr...
jira
4 commits
# 470,240
TypeScr...
slack
jira
HTML
4 commits
Auto Logo

Generate releases based on semantic version labels on pull requests


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


Automated releases powered by pull request labels. Streamline your release workflow and publish constantly!

auto
is meant to be run in a continuous integration (CI) environment, but all the commands work locally as well.

Release Features:

  • Calculate semantic version bumps from PRs
  • Skip a release with the
    skip-release
    label
  • Publish canary releases from PRs or locally
  • Generate changelogs with fancy headers, authors, and monorepo package association
  • Use labels to create new changelog sections
  • 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
  • Update the PR body with contextual build metadata

Visit the docs for more information.

:pushpin: Plugins :pushpin:

Auto has an extensive plugin system and wide variety of official plugins. Make a PR to add yours!

Package Managers:

  • brew - Automate the creation of Homebrew formulae
  • chrome - Publish code to Chrome Web Store
  • cocoapods - Version your Cocoapod, and push to your specs repository!
  • crates - Publish Rust crates
  • docker - Publish images with Docker
  • gem - Publish ruby gems
  • git-tag - Manage your projects version through just a git tag (
    default
    when used with binary)
  • gradle - Publish code with gradle
  • maven - Publish code with maven
  • npm - Publish code to npm (
    default
    when installed through
    npm
    )
  • vscode - Publish code to the VSCode extension marketplace

Extra Functionality:

  • all-contributors - Automatically add contributors as changelogs are produced using all-contributors-cli
  • conventional-commits - Parse conventional commit messages for version bumps
  • exec - Tap into hooks and run scripts on the terminal
  • first-time-contributor - Thank first time contributors for their work right in your release notes.
  • gh-pages - Automate publishing to your gh-pages documentation website
  • jira - Include Jira story links in the changelog
  • magic-zero - A plugin that closely adheres to semver versioning for 0.0.x and 0.x.y releases
  • microsoft-teams - Post your release notes to a Microsoft teams channel
  • omit-commits - Ignore commits base on name, email, subject, labels, and username
  • omit-release-notes - Ignore release notes in PRs made by certain accounts
  • pr-body-labels - Allow outside contributors to indicate what semver label should be applied to the Pull Request
  • released - Add a
    released
    label to published PRs, comment with the version it's included in and comment on the issues the PR closes
  • s3 - Post your built artifacts to amazon s3
  • slack - Post release notes to slack
  • twitter - Post release notes to twitter
  • upload-assets - Add extra assets to the release

:hammer: Start Developing :hammer:

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

yarn

Build/Typecheck

You must build at least once before running the tests or lint.

yarn build

In watch mode:

yarn start

Installing the binary

Install the bundled binary onto your system. This requires the project to be built or in watch mode.

yarn install-mac

If running this for the first time you may also have to run the following command.

chmod +x /usr/local/bin/auto

Cleaning

yarn clean

Linting

yarn lint

Testing

yarn test

Run the docs

yarn docs

Create a new plugin

Get started developing a new plugin in the monorepo in seconds.

The two arguments are:

  1. A spaced name
  2. A description
yarn create:plugin my-plugin "Do something really cool"

Create a new package

Get started developing a new package in the monorepo in seconds.

The two arguments are:

  1. A spaced name
  2. A description
yarn create:package my-package "Do something really cool"

:beers: Contributing :beers:

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

Make sure to read our code of conduct.

:rocket: Projects Using
auto
:rocket:

:star: Storybookjs design-system - Storybook's official design system

:star: space-kit - Home base for Apollo's design system

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

:star: reaction - Artsy’s React Components

:star: emission - Artsy’s React Native Components

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

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

:nailcare:
auto
Badge :nail
care:

Does your project use

auto
? Then use our custom badge!

Auto Release

Auto Release

Auto Release

Auto Release

:art: Prior Art :art:

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

Contributors

Thanks goes to these wonderful people (emoji key):


Adam Dierkens

πŸ’» πŸ“– πŸ€” ⚠️

Andrew Lisowski

πŸ’» πŸ“– πŸ€” πŸš‡ ⚠️ πŸ“

David

πŸš‡ ⚠️ πŸ’» πŸ“–

Orta

πŸ’» πŸ“–

Justin Bennett

πŸ› πŸ’» πŸ“– ⚠️

Alec Larson

πŸ’»

Tyler Krupicka

πŸ’»

Zachary Sherwin

πŸ’» πŸ“– ⚠️

bnigh

πŸ’» πŸ“– ⚠️

su7edja

πŸ’»

Yogesh Khandlewal

πŸ’»

Matt Boulanger

πŸ’»

Karen Lo

πŸ“–

James Nail

⚠️ πŸ’»

rdipika94

πŸ“–

Brian Muenzenmeyer

πŸ“– πŸ’»

Sarah van der Laan

πŸ“–

Hannes GΓΌdelhΓΆfer

πŸ’»

Eric Clemmons

πŸ’» πŸ“– ⚠️

Jeremiah Zucker

πŸ“– ⚠️ πŸ’»

Brandon Miller

πŸ’» πŸ“– ⚠️

Harris Borawski

πŸ“– ⚠️ πŸ’»

Shelby Cohen

πŸ“– ⚠️ πŸ’»

Kyle Brown

⚠️ πŸ’»

Till Weisser

πŸ“– ⚠️ πŸ’»

G. Richard Bellamy

πŸ“– πŸ’» ⚠️

Kevin Wolf

πŸ“– ⚠️ πŸ’»

Marty Henderson

πŸ“– ⚠️ πŸ’»

Spencer Hamm

πŸ’»

Lucas Shadler

πŸ’» ⚠️

David Stone

πŸ“– ⚠️ πŸ’»

Lucas Curti

πŸ’»

rachana

πŸ“– ⚠️ πŸ’»

Richard Simpson

πŸ“– ⚠️ πŸ’»

Arturo Silva

πŸ“–

Christy Jacob

πŸ“–

Check your git settings!

πŸ“–

Kendall Gassner

πŸ“– ⚠️ πŸ’»

Drew Cortright

πŸ“– ⚠️ πŸ’»

Philippe Boyd

πŸ“–

Mukul Chaware

πŸ“– ⚠️ πŸ’»

Tim Ottewell

πŸ“– ⚠️ πŸ’»

Andrew Leedham

πŸ“– ⚠️ πŸ’»

Seth Thomas

⚠️ πŸ’»

Evan Lovely

πŸ“–

Dorian MariΓ©

πŸ“–

myndelx

πŸ’»

sentony93

πŸ“– ⚠️ πŸ’»

Kelly Harrop

πŸ“– πŸ’»

Rogerio Angeliski

πŸ“– ⚠️ πŸ’»

Piotr Monwid-Olechnowicz

πŸ’» πŸ“–

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.

License

FOSSA Status

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.