question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Use https://keepachangelog.com format

See original GitHub issue

I think this is the line that replaces the ## Unreleased header to ## <version-number for a release: https://github.com/getsentry/craft/blob/2e4f74c618ce99c184d4a4643fd92abda5ad0724/src/commands/prepare.ts#L399

Two proposals to improve our workflow here:

  1. Instead of replacing ## Unreleased, simply insert \n\n## <version-number> beneath it, so the unreleased section is there waiting for when we want to add more things during development, instead of having to rewrite that after every release.
  2. To adhere more closely to the https://keepachangelog.com format (because we are about 95% of the way there), we should include the date of the release and enclose the formats in square brackets, as such: image

Issue Analytics

  • State:open
  • Created a year ago
  • Reactions:1
  • Comments:11 (10 by maintainers)

github_iconTop GitHub Comments

1reaction
armcknightcommented, Oct 29, 2022

Understood @BYK. I was only pointing out the need for my proposed change if, for whatever reason, people don’t want to use the automated changelog feature.

1reaction
BYKcommented, Oct 17, 2022

@armcknight It does much more than that if you are willing to use it. Here’s a good example: https://github.com/getsentry/craft/releases/tag/0.25.0 – It uses GitHub milestones to group PRs and use a better wording and sectioning for a feature. Some more docs here: https://github.com/getsentry/craft#changelog-policies

Read more comments on GitHub >

github_iconTop Results From Across the Web

Keep a Changelog
Changed - Start using "changelog" over "change log" since it's the common ... Changed - Clarified the section on "Is there a standard...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found