From d295031fa6c94271ec551f32bba55f9cd99c998e Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Fri, 5 Jul 2024 01:46:48 +0200 Subject: [PATCH] docs: add branching model to README.md MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- .github/workflows/release-please.yml | 2 +- README.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 89a57cf5..9ef9b95a 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -25,7 +25,7 @@ jobs: run: | git config user.name github-actions[bot] git config user.email 41898282+github-actions[bot]@users.noreply.github.com - git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/googleapis/release-please-action.git" + git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" git tag -d v${{ steps.release.outputs.major }} || true git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true git push origin :v${{ steps.release.outputs.major }} || true diff --git a/README.md b/README.md index 183c3329..7ba9efe6 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,12 @@ choco install volta Setup [volta](https://volta.sh/) with [pnpm](https://github.com/pnpm/pnpm) package manager support: https://docs.volta.sh/advanced/pnpm +### Branching model + +The `main` branch is the default development branch. +The `vX` branches are the maintenance branches for the corresponding major version `X`. +The `vX.Y` branches are the maintenance branches for the corresponding major and minor version `X.Y`. + ### Dependencies Enable corepack, if [volta](https://volta.sh/) is not installed and configured, and install latest pnpm version: -- 2.34.1