README
Buffer Composer Auto PR
A simple CLI tool for automatically creating PRs to upgrade buffer-web
and buffer-publish
to use the latest composer.
All you need to do is make and merge your changes into buffer-composer
and this command will:
- Ensure you have the correct dependencies setup
- Run a number of checks to make sure you're ready to upgrade the version
- Publish the composer to NPM (if needed)
buffer-web
- Update the
@bufferapp/composer
version inpackage.json
- Bundle the JS code (gulp)
- Create a branch and PR on GitHub
- Update the
buffer-publish
- Update the
@bufferapp/composer
version inpackages/compsoer-popover/package.json
- Create a branch and PR on GitHub
- Update the
As it completes it will open the pull requests in your browser for further editing/assignemnt/etc.
Installation
First, you'll need the hub
cli tool installed:
$ brew install hub
⚠️ Make sure you use hub
at least once to create the necessary credentials in your home directory, something like this will work:
$ cd buffer-composer
$ hub pr list
# Enter your GitHub credentials...
Now you're ready to install composer-auto-pr!
🎉
$ npm install -g @bufferapp/composer-auto-pr
The CLI tools is now installed and ready to run!
Usage
Follow the usual process of making changes to the composer on a branch, creating a PR for that branch, and then finally merging that branch into master. (This includes bumping the version number as well, either manually or with
npm version <major|minor|patch>
)Once your composer changes are on master you can now run this tool to automate PR creation! It will also take care of publishing the new version to NPM (if you haven't already). 😍
$ cd buffer-composer
$ composer-auto-pr
# Here we go! ⚡️