Skip to content
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

Merged
merged 14 commits into from
Jun 25, 2021
Merged

Conversation

tlgimenes
Copy link
Contributor

@tlgimenes tlgimenes commented Jun 25, 2021

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
image

@netlify
Copy link

netlify bot commented Jun 25, 2021

✔️ 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

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jun 25, 2021

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:

Sandbox Source
Store UI Typescript Configuration

@tlgimenes tlgimenes changed the title Chore/changelog Chore | Changelog Jun 25, 2021
@tlgimenes tlgimenes marked this pull request as ready for review June 25, 2021 17:59
@tlgimenes tlgimenes requested a review from a team as a code owner June 25, 2021 17:59
@tlgimenes tlgimenes changed the title Chore | Changelog feat: add changelog Jun 25, 2021
@tlgimenes tlgimenes changed the title feat: add changelog feat: add changelog with conventional commits Jun 25, 2021
Copy link
Contributor

@Gmantiqueira Gmantiqueira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, nice!

@tlgimenes tlgimenes merged commit d8dfb0f into master Jun 25, 2021
@tlgimenes tlgimenes deleted the chore/changelog branch June 25, 2021 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants