From c00bbdacf4ac181cf47536bba3581c2910301b8f Mon Sep 17 00:00:00 2001 From: Gerald Shen <119401249+gshennvm@users.noreply.github.com> Date: Tue, 9 Jan 2024 10:47:22 -0800 Subject: [PATCH] add dev github action and update contributing guide (#77) Signed-off-by: Gerald Shen --- .github/workflows/sync_branch.yaml | 24 ++++++++++++++++++++++++ CONTRIBUTING.md | 6 +++++- 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/sync_branch.yaml diff --git a/.github/workflows/sync_branch.yaml b/.github/workflows/sync_branch.yaml new file mode 100644 index 000000000..028f774ff --- /dev/null +++ b/.github/workflows/sync_branch.yaml @@ -0,0 +1,24 @@ +name: sync main with dev +on: + push: + branches: + - main + +jobs: + sync-branches: + runs-on: ubuntu-latest + name: syncing main with dev + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Set up Node + uses: actions/setup-node@v1 + with: + node-version: 12 + - name: Opening pull request + id: pull + uses: tretuna/sync-branches@1.4.0 + with: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + FROM_BRANCH: "main" + TO_BRANCH: "dev" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4041806a8..ec1293b81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for the interest in contributing to NeMo-Aligner. We do all of NeMo-Align # Pull Requests (PR) Guidelines -**Send your PRs to the `main` branch** +**Send your PRs to the `main` or `dev` branch** 1) Make sure your PR does one thing. Have a clear answer to "What does this PR do?". 2) Read General Principles and style guide below @@ -12,6 +12,10 @@ Thanks for the interest in contributing to NeMo-Aligner. We do all of NeMo-Align 4) Make sure all unittests finish successfully before sending PR ``pytest`` or (if your dev box does not have GPU) ``pytest --cpu`` from the root folder 5) Send your PR and request a review +**NOTE**: The `main` branch uses a fixed NeMo version which we will update on every release. The `dev` branch is the branch that has all commits from `main` but uses NeMo's main branch: this branch is less stable but we run nightly tests on it to make sure everything works. We only provide the dockerfile that works with `main`, which is the branch most PRs should target unless they require the latest NeMo main (in which case they should target `dev`). + +Every release `dev` and `main` will sync to be the same. + ## Unit tests Quick unit tests (locally, while developing) ```