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.

Merged changelog has wrong changelog entry

See original GitHub issue

Every merged PR with a changelog entry within a release might end up in the wrong changelog version entry.

Steps:

Cut a release from main, it creates the release branch. 2, Do not approve the release yet.
Merge a PR into the main branch with a changelog entry.
Approve the release that merges the release branch into the main branch.
The changelog entry from step 3 is within the release but it’s not published since this PR was merged after step 1.

The problem is that you always have to check that manually after releases, or your changelog might have wrong entries.

Image gotten from: https://github.com/getsentry/sentry-react-native/commits/main

Issue Analytics

State:
Created 2 years ago
Reactions:1
Comments:10 (10 by maintainers)

Top GitHub Comments

1reaction

marandanetocommented, Mar 8, 2022

@marandaneto @bruno-garcia

The problem with auto is that every merged PR is gonna be within the release, even meta changes or non user-facing changes. We try to keep our changelog as clean as possible, so users don’t need to dig into every PR or read every meta change. I wanted to try the auto changelog a while ago but @bruno-garcia came up with the same arguments, so we’re still doing it via the Unreleased entry.

If you want to keep things clean, you can use auto changelogs as they are intended: use milestones to group the work and the rest gets collected under “various fixes and improvements”, which may still be relevant to people. If you are 100% sure something that should not go to the auto changelog, you can always add #skip-changelog to a commit or a PR (even after the fact that it was merged) to omit it from the changelog:

https://github.com/getsentry/craft/blob/6d523c5883eb0cadfa6ab33220d966e2ffd5fca9/src/utils/changelog.ts#L14

#knowyourtools 😃

Thanks @BYK I will discuss that with @bruno-garcia We already use #skip-changelog, so that would likely do.

1reaction

BYKcommented, Mar 7, 2022

Okay so identified the issue here. It is just a merge error, nothing to do with Craft itself. This happens in https://github.com/getsentry/sentry-react-native/commit/56c9319624c38be2331113ff17e2ac48db628098.

The actual Changelog and the changelog entry in the GitHub releases page are correct.

If you want to avoid these kinds of issues, using Craft’s auto changelog feature is the best: https://github.com/getsentry/craft#changelog-policies

Top Results From Across the Web

Changelog entries - GitLab Docs

If your merge request has multiple commits, make sure to add the Changelog entry to the first commit. This ensures that the correct...

Question: How to version control the changelog? #253 - GitHub

When changes are merged into the mainline branch by QA, QA goes in and adds a proper version number. That way, we rarely...

Prevent automatic changelog merging - Stack Overflow

This is what's called a semantic conflict. The code merges correctly without conflicts, but the result is not what you wanted.

Changelog · Development · Help · GitLab

Each list item, or entry, in our CHANGELOG.md file is generated from the ... When generating the changelog, author and merge request details...

Changelog entries - Help · GitLab

Our CHANGELOG file was previously updated manually by each contributor that felt their change warranted an entry. When two merge requests added their...