docs: add branching model to README.md

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
index 89a57cf53fe3c75f38be3e1ebaae56fa3a504f3c..9ef9b95ac8c5dd41feee3fe30f2f8967f55211e8 100644 (file)
--- 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 183c3329c4afac812eb840013961747b8ade2bac..7ba9efe61c66fb3ed1148a94d5fe716ed8f30043 100644 (file)
--- 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: