From 9147a81987a7c829dcb772914a9c05100116d4f5 Mon Sep 17 00:00:00 2001 From: CI Automation Date: Fri, 25 Oct 2024 10:18:12 +0200 Subject: [PATCH] Document recreating notes --- release-controller/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/release-controller/README.md b/release-controller/README.md index 5ff1a1271..7dc1fa331 100644 --- a/release-controller/README.md +++ b/release-controller/README.md @@ -15,6 +15,18 @@ Automates parts of the process of proposing new releases for 2. Once the Google Doc is finished (all teams crossed out), PR will be created with release notes. Once it's merged, the proposal will be placed and forum post updated. +## Recreating notes + +Sometimes you'd want to recreate notes, either because a bug occured on the first generation, or you just want to have updated version of the notes submitted. + +### Recreate Google Doc + +To recreate Google Doc, remove the document from [Google Drive directory](https://drive.google.com/drive/folders/1y-nuH29Gd5Err3pazYH6-LzcDShcOIFf) or rename it such that it doesn't include any release details. + +### Recreate GitHub PR with release notes + +To recreate GitHub PR, close the outstanding PR and make sure to **delete the branch of the PR**. + ## Contributing The project is split into two parts - commit annotator and reconciler.