opensearch-project / opensearch-dashboards-functional-test

Maintains functional tests for OpenSearch Dashboards and Dashboards plugins
Apache License 2.0
12 stars 113 forks source link

Discuss about backport process #353

Open tianleh opened 2 years ago

tianleh commented 2 years ago

The issue is to start a discussion about improving the backport process in the repo.

Currently the backport happens when the PR author adds the backport label or the maintainer needs to ask the author whether the PR requires backport. We want to improve the experience for both PR authors and maintainers. Note that PR authors may or may not have the permission to add labels.

We can discuss the topic from the following two topics.

  1. How do we know whether backport is needed? This can be contributed from both PR authors and maintainers. If PR authors know which branches to backport, they shall mention that in the PR and add the related labels if with permission. If PR authors do not know such, they shall also mention such to start a discussion with maintainer. For maintainers, they shall check the backport information on the PR. If explicitly mentioned, then add the labels if missing. If not explicitly mentioned, they shall ask this question on the PR before approving it.

One proposal to streamline the process is to add a checklist item on the PR https://github.com/opensearch-project/opensearch-dashboards-functional-test/blob/main/PULL_REQUEST_TEMPLATE.md about whether backport is needed and which versions shall be backported. PR authors can also call out that they are not sure about backport.

  1. Who will perform the backport? It will be the maintainer's responsibility to review and merge the backport PR. Generally speaking, maintainers shall also resolve merge conflict. However, there could be an edge case that the code structure in the target branch is significantly different from the main branch which makes the backport almost a new implementation. In this case, the PR author may need to perform such implementation.
tianleh commented 2 years ago

@kavilla @CCongWang @ohltyler

cc @seraphjiang @ZilongX @mpabba3003 @kristenTian

tianleh commented 2 years ago

cc @ashwin-pc @yibow98 @RyanL1997

seraphjiang commented 2 years ago

The issue is to start a discussion about improving the backport process in the repo.

Could we convert to a proposal or rfc, and raise a PR to update https://github.com/opensearch-project/opensearch-dashboards-functional-test/blob/main/CONTRIBUTING.md

  1. How do we know whether backport is needed?

Is there any PR ( + backport) follow the practice as proposal could be list here as reference? could we

ashwin-pc commented 1 year ago

@tianleh I like the proposal. Simple and clean.