From d62f804666a13823894aac5ede17f279b2ad95e0 Mon Sep 17 00:00:00 2001 From: Daniil Fedotov Date: Mon, 14 Oct 2024 15:26:39 -0400 Subject: [PATCH] docs: add note about committing release notes before generating a changelog (#3181) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- RELEASE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index a19d6a5c08..ca03e4d584 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -36,6 +36,8 @@ make reno-report VERSION= ``` And then committed to the pre-release branch. +**IMPORTANT** Reno scans commits to detect release notes. Only committed release notes will be added to the CHANGELOG files. + ### Release workflow `release` workflow tags the repo using `release_tag` variable either from the merged pre-release PR or from workflow dispatch.