opensearch-project / OpenSearch

🔎 Open source distributed and RESTful search engine.
https://opensearch.org/docs/latest/opensearch/index/
Apache License 2.0
9.46k stars 1.74k forks source link

[Feature Request] Backports fail often due to CHANGELOG conflicts #15149

Open jainankitk opened 1 month ago

jainankitk commented 1 month ago

Is your feature request related to a problem? Please describe

The backport fails for most PR due to conflicts on CHANGELOG.md. I am wondering if there is better way around this.

Describe the solution you'd like

Maybe provide some conflict resolution hints specifically for CHANGELOG.md?

Related component

Build

Describe alternatives you've considered

No response

Additional context

No response

dblock commented 1 month ago

Good idea. In the case where the diff is a 1-liner, try to apply both by default.

sandeshkr419 commented 1 month ago

Agreed @ankitkala on unnecessary blockers caused by this. The most frustrating part is users not able to edit the changelog in UI and then commit it right away. The part where you have to manually checkout the code and raise a manual backport PR is irritating. Also, chances for human errors - what if I mistakenly edit other files.

In the case where the diff is a 1-liner, try to apply both by default.

I think for changelog failures - in CI for backport PRs, we can automate this.

Probably need to trigger something like git-merge-file --union in case of conflicts in changelog, haven't checked the exact usage, but looks like we can edit our CI to do a concatenate in changelog. Also, this can also be a comment command to github-actions to run a script and resolve conflicts, and commit changes. Reference: https://git-scm.com/docs/git-merge-file

dblock commented 2 weeks ago

[Catch All Triage - 1, 2, 3, 4, 5]