From d60159c9fab94dd1cebe67743fbf87c66603ac51 Mon Sep 17 00:00:00 2001 From: Prabhat Sharma Date: Mon, 29 Apr 2024 09:23:07 +0530 Subject: [PATCH] Fixed Backport section in developer guide Signed-off-by: Prabhat Sharma --- DEVELOPER_GUIDE.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index b4a45f17b..e74327478 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -77,6 +77,10 @@ In the base OpenSearch Dashboards directory, run - Runs the Cypress test runner -### Backport +### Backports -- [Link to backport documentation](https://github.com/opensearch-project/opensearch-plugins/blob/main/BACKPORT.md) \ No newline at end of file +The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates backport PRs automatically when the +original PR with an appropriate label `backport ` is merged to main with the backport workflow +run successfully on the PR. For example, if a PR on main needs to be backported to `1.x` branch, add a label +`backport 1.x` to the PR and make sure the backport workflow runs on the PR along with other checks. Once this PR is +merged to main, the workflow will create a backport PR to the `1.x` branch. \ No newline at end of file