opensearch-project/OpenSearch

[Feature Request] Show backport conflicts pre-merge on PRs

Open

#12,097 opened on Jan 30, 2024

View on GitHub
 (4 comments) (2 reactions) (0 assignees)Java (1,505 forks)batch import
Buildenhancementgood first issue

Repository metrics

Stars
 (8,123 stars)
PR merge metrics
 (Avg merge 5d 9h) (266 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe

The backport automation, when it works, greatly reduces the manual effort to maintain other branches. However, sometimes it fails but we don't get any indication that it will fail until after the PR on main is committed. I think it would be nice to know ahead of time if my PR will generate a conflict on backport, and to know which files will conflict. This gives me an opportunity to fix it ahead of time if possible. (The usual avoidable conflicts are due to an incorrect CHANGELOG entry, but this still strikes me as being potentially useful even if we improve the CHANGELOG process to avoid contention on a single file)

Describe the solution you'd like

If I add a backport 2.x label to my PR, then a GitHub action is run that tells me either one of the following:

  • My commit will cleanly backport to the 2.x branch
  • My commit will not cleanly backport, and which files have conflicts that must be manually resolved

Related component

Build

Contributor guide

Research direction
Examine existing backport workflows and identify where to add a pre merge conflict detection step.
Tech stack
java
Domain
devopsci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50