From 84772904be5065523736b5511b7c257ebe27c988 Mon Sep 17 00:00:00 2001 From: Vacha Date: Tue, 23 Nov 2021 13:45:50 -0800 Subject: [PATCH] Adding Github action for auto backport PR creation (#1600) * Adding Github action for auto backport PR creation Signed-off-by: Vacha * Adding details to DEVELOPER_GUIDE Signed-off-by: Vacha --- .github/workflows/backport.yml | 16 ++++++++++++++++ DEVELOPER_GUIDE.md | 7 ++++++- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/backport.yml diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml new file mode 100644 index 0000000000000..c0d07fef80ffe --- /dev/null +++ b/.github/workflows/backport.yml @@ -0,0 +1,16 @@ +name: Backport +on: + pull_request: + types: + - closed + - labeled + +jobs: + backport: + runs-on: ubuntu-latest + name: Backport + steps: + - name: Backport + uses: tibdex/backport@v1 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 17f592e078908..9fb6f91e31110 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -3,7 +3,7 @@ - [Git Clone OpenSearch Repo](#git-clone-opensearch-repo) - [Install Prerequisites](#install-prerequisites) - [JDK 11](#jdk-11) - - [JDK 8 and 17](#jdk-8-and-17) + - [JDK 8 and 14](#jdk-8-and-14) - [Runtime JDK](#runtime-jdk) - [Windows](#windows) - [Docker](#docker) @@ -44,6 +44,7 @@ - [Aggregations](#aggregations) - [Distributed Framework](#distributed-framework) - [Submitting Changes](#submitting-changes) + - [Backports](#backports) # Developer Guide @@ -408,3 +409,7 @@ Includes: ## Submitting Changes See [CONTRIBUTING](CONTRIBUTING.md). + +## Backports + +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. For example, if a PR on main needs to be backported to `1.x` branch, add a label `backport 1.x` to the PR. 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