-
Notifications
You must be signed in to change notification settings - Fork 91
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
docs(adr): add draft ADR for library release automation #1576
Conversation
✅ Deploy Preview for stacks ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Absolutely, this is out of scope for STACKS-417. We have other placeholder stories in place which should be updated linking to this ADR. 🙂 |
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.
Overall it looks good to me. 🙂
I believe the only thing I would add is a small section explaining why we picked changesets over "other tools" (e.g. release-please, sematic-release, etc... - there might be more).
We don't need to necessarily do deep research on them but at least mention what we have quickly evaluated. For example semantic-release doesn't support monorepo setups well. Release please if I recall correctly doesn't have an automated way to publish to npm (but I might be wrong).
One more thing worth highlighting in the ADR is that despite changesets incentivize describing changes independently from the commit messages we are still committed to follow conventional-commits. You can probably take inspiration from what I have wrote here.
Thanks @dancormier. ❤️
Co-authored-by: Giamir Buoncristiani <[email protected]>
…StackExchange/Stacks into dcormier/release-automation-adr
@giamir thank you for your review! i made the changes you suggested and will merge this PR shortly. If you see any recent changes that need improvement, please let me know and I'll open a new PR. |
STACKS-417.
This PR adds an ADR to describe the decision to use Changesets as a way to automate away much of the manual effort currently necessary to cut releases (across all Stacks libraries).