-
Notifications
You must be signed in to change notification settings - Fork 244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
release workflow #801
Labels
enhancement
New feature or request
Comments
It sounds like |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Maintaining an open source library is a thing, but releasing the changes is another thing not to forget about.
I'd like to suggest a release workflow that we use for InstantSearch.js at Algolia. It's done by a homemade tool named Ship.js.
While semantic-release is a great tool and releases the library fully automatically, Ship.js gives you a little bit of control. Let's assume it's already setup in VTU repo.
If you run
shipjs prepare
, it will create a release pull-request like this. It includes the changes like bumping the version and updating changelog. It automatically requests for review to those configured inship.config.js
. In the PR, you can update the CHANGELOG if you want. Once approved and merged, now the CI kicks in and it will runshipjs trigger
command. And it will release to NPM, creates a git tag, and a release on GH too.What we do in the InstantSearch team is to automate
shipjs prepare
command. So Circle CI runs it for us every Tuesday morning. We do nothing, just receive a release PR every Tuesday, review and merge it.Let me know if you're interested. I can make a PR to add this.
If you're not interested, I can still make a PR to add semantic-release.
The text was updated successfully, but these errors were encountered: