Skip to content

Generate releases based on semantic version labels on pull requests.

License

Notifications You must be signed in to change notification settings

o-alexandrov/auto-release

Β 
Β 

Repository files navigation

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

yarn docs:watch

Contributing

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

Make sure to read our code of conduct.

πŸš€ Projects Using auto-release πŸš€

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

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

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

⭐ react-glider - A react wrapper for glider.js

⭐ Ignite - Modern markdown documentation generator

⭐ reaction - Artsy’s React Components

πŸ’… auto-release Badge πŸ’…

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

Auto Release

Auto Release

Auto Release

Auto Release

🎨 Prior Art 🎨

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

Contributors

Thanks goes to these wonderful people (emoji key):


Adam Dierkens

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

Andrew Lisowski

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

David

πŸš‡

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.

About

Generate releases based on semantic version labels on pull requests.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.7%
  • Shell 0.3%