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

Task/cliff changelog #4907

Merged
merged 20 commits into from
Oct 3, 2023
Merged

Task/cliff changelog #4907

merged 20 commits into from
Oct 3, 2023

Conversation

chriswk
Copy link
Contributor

@chriswk chriswk commented Oct 2, 2023

What

Initial effort at automating the task of updating CHANGELOG when doing releases.

This initial PR sets up the tool https://git-cliff.org/ and adds our missing updates since 4.2.0

The tool should be explored further, we could have the CHANGELOG linking linear issues, not just github issues, as well as ideally each commit displayed with it's short sha. However, rather than not having anything like this for the last 20+ releases, this will at least have our conventional commits be included in the CHANGELOG file.

Next PR will setup up an automated task to run along with the release tasks to ensure we keep it up to date when releasing.

@vercel
Copy link

vercel bot commented Oct 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Updated (UTC)
unleash-docs ⬜️ Ignored (Inspect) Oct 2, 2023 0:42am
unleash-monorepo-frontend ⬜️ Ignored (Inspect) Oct 2, 2023 0:42am

Copy link
Contributor

@gastonfournier gastonfournier left a comment

Choose a reason for hiding this comment

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

I like how it looks! I think we'll get better at conventional commits over time now that we get to see the output of changelog 👍

@chriswk chriswk merged commit b319cec into main Oct 3, 2023
11 checks passed
@chriswk chriswk deleted the task/cliffChangelog branch October 3, 2023 07:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants