From cce87cb1965a68afcaa8ad2e1a096ca1dbca7d04 Mon Sep 17 00:00:00 2001 From: Shalin Patel Date: Tue, 17 Sep 2024 15:06:04 -0700 Subject: [PATCH] docs: update dev doc for creating release-please branch for releases --- docs/content/contributing/releasing.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/content/contributing/releasing.md b/docs/content/contributing/releasing.md index c1883a27c..b9266b514 100644 --- a/docs/content/contributing/releasing.md +++ b/docs/content/contributing/releasing.md @@ -10,7 +10,10 @@ This project uses [release-please] to automate changelog updates per release. Du [release-please-action]. When a release has been cut, a new release PR can be created manually using the `release-please` CLI locally. This needs -to be run by someone with write permissions to the repository. Create the `release-please` branch and PR: +to be run by someone with write permissions to the repository. +The new release PR can be only created against `main` or `release/*` branch. +Ensure to checkout `main` or `release/*` branch locally. +Create the `release-please` branch and PR from `main` or `release/*` branch: ```shell make release-please