From 6fa8eed89aa4cf6236208c84be8fd90d8146c9e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tadej=20Jane=C5=BE?= Date: Mon, 3 May 2021 13:31:24 +0200 Subject: [PATCH 1/2] docs: Avoid / in backport/changelog git branch names in Release Process Apparently, Git has a limitation where if branch named 'b' exists, no branch named 'b/something' can be created: https://stackoverflow.com/a/22630664/1872673. Hence, if branch named 'stable/21.2.x' exists, one is unable to create a 'stable/21.2.x/backport-foo' or 'stable/21.2.x/changelog' branch. --- docs/release-process.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/release-process.md b/docs/release-process.md index b425cdcee6c..72190ebc7d5 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -175,11 +175,11 @@ export RELEASE_BRANCH="stable/21.2.x" ### Back-port Changes -Create a new branch, e.g. `${RELEASE_BRANCH}/backport-foo`, from the +Create a new branch, e.g. `${RELEASE_BRANCH}-backport-foo`, from the `${RELEASE_BRANCH}` branch: ```bash -git checkout -b ${RELEASE_BRANCH}/backport-foo ${RELEASE_BRANCH} +git checkout -b ${RELEASE_BRANCH}-backport-foo ${RELEASE_BRANCH} ``` After back-porting all the desired changes, push it to the origin and make a @@ -191,11 +191,11 @@ As with a regular release, the back-ported changes should include the corresponding [Change Log Fragments] that need to be assembled into a new section of the [Change Log] using the `changelog` [Make] target. -Create a new branch, e.g. `${RELEASE_BRANCH}/changelog`, from the +Create a new branch, e.g. `${RELEASE_BRANCH}-changelog`, from the `${RELEASE_BRANCH}` branch: ```bash -git checkout -b ${RELEASE_BRANCH}/changelog ${RELEASE_BRANCH} +git checkout -b ${RELEASE_BRANCH}-changelog ${RELEASE_BRANCH} ``` Then run [Make]'s `changelog` target: From f81c04009c9616a04e2fdc39123198ae6e995450 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tadej=20Jane=C5=BE?= Date: Thu, 3 Jun 2021 18:09:03 +0200 Subject: [PATCH 2/2] changelog: Fix name and a typo in doc fragment for PR #3891 --- .changelog/3891.doc.md | 3 +++ .changelog/3891.docs.md | 3 --- .changelog/3993.doc.md | 3 +++ 3 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 .changelog/3891.doc.md delete mode 100644 .changelog/3891.docs.md create mode 100644 .changelog/3993.doc.md diff --git a/.changelog/3891.doc.md b/.changelog/3891.doc.md new file mode 100644 index 00000000000..6e7d6afd149 --- /dev/null +++ b/.changelog/3891.doc.md @@ -0,0 +1,3 @@ +Note that `RELEASE_BRANCH` variable needs to be exported in [Release Process] + +[Release Process]: docs/release-process.md diff --git a/.changelog/3891.docs.md b/.changelog/3891.docs.md deleted file mode 100644 index 7e2f05d4aa3..00000000000 --- a/.changelog/3891.docs.md +++ /dev/null @@ -1,3 +0,0 @@ -Note that `RELEASE_BRANCH` variable need to be exported in [Release Process] - -[Release Process]: docs/release-process.md diff --git a/.changelog/3993.doc.md b/.changelog/3993.doc.md new file mode 100644 index 00000000000..6e7d6afd149 --- /dev/null +++ b/.changelog/3993.doc.md @@ -0,0 +1,3 @@ +Note that `RELEASE_BRANCH` variable needs to be exported in [Release Process] + +[Release Process]: docs/release-process.md