-
Notifications
You must be signed in to change notification settings - Fork 63
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
feat: add changelog with conventional commits #790
Conversation
✔️ Deploy Preview for storeui ready! 🔨 Explore the source changes: ce1073b 🔍 Inspect the deploy log: https://app.netlify.com/sites/storeui/deploys/60d660661e33010007ae49de 😎 Browse the preview: https://deploy-preview-790--storeui.netlify.app |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit ce1073b:
|
8f4a2f0
to
c090ebc
Compare
2a8125d
to
4b0ffa1
Compare
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.
LGTM, nice!
4b0ffa1
to
ce1073b
Compare
What's the purpose of this pull request?
Add changelog using lerna built-in capabilities. Also, for testing purposes, I've moved the index file from store-ui to store-ui/deprecated and re-exported all apis in a new index file.
How do I add something to the changelog?
You don't really need to modify
CHANGELOG.md
file directly.CHANGELOG.md
is autogen based on your commit merge message. That's why that commit merge messages need to follow a certain protocol now. This protocol is called conventional commits.Examples
To generate a fix you now must create a commit with the folowing message:
fix: describe what you are fixing in here
We can verify this is actually being followed by checking the PR title. The PR title will eventualy become the merge commit message and will be used to generate the changelog.
Example of the generated changelog