From 05524eb99efaeba0d019d3f97ee9ee565279d924 Mon Sep 17 00:00:00 2001 From: Waldemar Heinze <1307809+wheinze@users.noreply.github.com> Date: Tue, 5 Dec 2023 00:58:19 +0100 Subject: [PATCH] docs: update to `target-branch` option for non-default branch (#895) This PR updates the docs to switch usages to `target-branch` as this has changed in v4. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a63523c..8bc638f 100644 --- a/README.md +++ b/README.md @@ -232,7 +232,7 @@ The most important prefixes you should have in mind are: ### Supporting multiple release branches `release-please` has the ability to target not default branches. You can even use separate release strategies (`release-type`). -To configure, simply configure multiple workflows that specify a different `default-branch`: +To configure, simply configure multiple workflows that specify a different `target-branch`: Configuration for `main` (default) branch (`.github/workflows/release-main.yaml`): @@ -252,7 +252,7 @@ jobs: release-type: node # The short ref name of the branch or tag that triggered # the workflow run. For example, `main` or `1.x` - default-branch: ${{ github.ref_name }} + target-branch: ${{ github.ref_name }} ``` ## Automating publication to npm