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

Avoid conflicts when adding changelog entries #99

Open
qsantos opened this issue Dec 12, 2023 · 0 comments
Open

Avoid conflicts when adding changelog entries #99

qsantos opened this issue Dec 12, 2023 · 0 comments

Comments

@qsantos
Copy link

qsantos commented Dec 12, 2023

Currently, adding a changelog entry is done by appending a TOML section to .changelog/_unreleased.toml. However, this directly leads to merge conflict when MRs are opened concurrently.

This can be partially mitigated by inserting the new changelog entry at a random point in the file, instead of appending to the end. However, this is only possible when the file already contains multiple entries, and the probability of conflict is still high.

A more robust solution would be to have a _unreleased/ directory instead, and creating a new file for each entry. The file name could be either be chosen arbitrarily by the contributor (with a non-negligible chance of collision), or use the UUID from the id field. The files could then be optionally sorted, and merged together for a new release.

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

No branches or pull requests

1 participant