docs: update release notes workflow (#4311)

Adds sections for notable changes and deprecation notes, and documents these sections needing to be filled, in the release notes. Signed-off-by: Shashank Ram <[email protected]>
openservicemesh · Oct 25, 2021 · 30a2f05 · 30a2f05
1 parent 91dca3e
commit 30a2f05
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/release_guide.md b/docs/release_guide.md
@@ -108,8 +108,7 @@ upload the packaged binaries and checksums as release assets, build and push Doc
 
 ## Add release notes
 
-In the description section of the new release, add information about feature additions, bug fixes,
-and any other administrative tasks completed on the repository.
+The release job runs the `scripts/release-notes.sh` script to generate release notes for the specific release tag. Update the `Notable Changes` and `Deprecation Notes` section based on notable feature additions, critical bug fixes, and deprecated functionality.
 
 ## Update documentation and docs.openservicemesh.io website
 

diff --git a/scripts/release-notes.sh b/scripts/release-notes.sh
@@ -28,6 +28,10 @@ if [[ -z "$crd_changes" ]]; then
 fi
 
 cat <<EOF
+## Notable Changes
+
+## Deprecation Notes
+
 ## CRD Updates
 
 $crd_changes