-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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 merge conflicts in CHANGELOG.md #2311
Comments
It looks like github doesn't currently support |
@jlowin, you self assigned this - are you still planning on taking this on? Otherwise I may hack on this at some point early next week. |
I sincerely apologize, I must have done that by mistake! |
So I got this working with towncrier, but before I finish up the PR I want to make sure we're happy with the functionality it provides. The workflow is:
I think having individual contributors add a file to the I'm less sold on the formatting that
I'm not sure if the above dissatisfaction is enough to write our own script. Fundamentally compiling multiple changelog files into a single changelog on release isn't terribly complex, so creating a custom script wouldn't be a massive undertaking. But I want to get a yay/nay before I do anything else. |
If we were to make our own tool, I'd probably have the filename be the PR or issue number (for uniqueness, filename not significant). I'd also use yaml to structure the content. Something like:
|
I went ahead and did this in #2529. |
With the current changelog policy (add an entry as part of the PR, all in one file) it's quite easy to run into merge conflicts as features are developed concurrently. This is not a problem unique to Prefect, many projects have run into this issue. There are three common solutions:
CHANGELOG.md
file (merge=union
) to better handle these conflicts. This will usually work, but may run into issues if concurrently added features have very similar lines.-
list rows), and rely on developers adding entries in different spots to avoid merge conflicts.The text was updated successfully, but these errors were encountered: