-
Notifications
You must be signed in to change notification settings - Fork 87
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
chore: add release please #110
Conversation
cd6513b
to
f3cca42
Compare
RELEASE.md
Outdated
# Releasing | ||
|
||
1. Merge the release PR | ||
2. Run `npm publish` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add https://github.com/googleapis/release-please#how-should-i-write-my-commits and general instructions to this doc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure I'll add the instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I replaced this with a contributing guide, please let me know what you think
|
f3cca42
to
688eed7
Compare
It should
Marked it ready |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome ty!!!!!!!
* chore: add release please (#110) * chore(release-please): use GitHub app token (#203) * fix: update repo * chore: add fossa * chore: add node 12 test * chore: update readme * fix: update tests to support node 12 * chore: add bug report form Co-authored-by: Erez Rokah <[email protected]> Co-authored-by: Kristy Marcinova <[email protected]>
This is what we use in our team for release automation.
It takes care of versioning, changelog generation, tagging and publishing GitHub releases.
On each commit to
main
release-please
checks if there is something that justifies a release, based on conventional commit messages and then creates a relevant release PR (e.g netlify/cli#1969).Once the release PR is merged
release-please
tags the commit and creates a GitHub release.To make this work, it requires writing commit messages in a specific way. See here for more information.
There are other ways to automate releases, but we like this one as it doesn't require pushing directly to the default branch.
PR is at draft to get some feedback.