ci(release): include manual notes in draft releases

Signed-off-by: Roel de Cort <roel.decort@adfinis.com>

Author: dc-tec

docs/contribute/release-management.md

@@ -108,7 +108,7 @@ Release-please remains the source of truth for release notes. After release-plea
 
 <Callout type="note" title="Human release notes">
 
-Keep `CHANGELOG.md` generated by release-please. Put hand-written release summaries, migration notes, and operator-facing callouts in `release-notes/X.Y.Z.md`; the website release generator prepends that file to the generated changelog entry for the matching version.
+Keep `CHANGELOG.md` generated by release-please. Put hand-written release summaries, migration notes, and operator-facing callouts in `release-notes/X.Y.Z.md`; the website release generator and draft GitHub Release creation prepend that file to the generated changelog entry for the matching version.
 
 </Callout>
 

hack/ci/create-release-tag-and-draft.sh

@@ -7,6 +7,7 @@ set -euo pipefail
 BASE_BRANCH="${BASE_BRANCH:-main}"
 MANIFEST_FILE="${MANIFEST_FILE:-.release-please-manifest.json}"
 CHART_FILE="${CHART_FILE:-charts/openbao-operator/Chart.yaml}"
+RELEASE_NOTES_DIR="${RELEASE_NOTES_DIR:-release-notes}"
 DRY_RUN="${DRY_RUN:-0}"
 
 GH_READ_TOKEN="${GH_READ_TOKEN:-${GH_TOKEN:-}}"
@@ -74,6 +75,44 @@ sanitize_release_notes() {
   '
 }
 
+manual_release_notes_path() {
+  local version="$1"
+  local extension path
+
+  for extension in mdx md; do
+    path="${RELEASE_NOTES_DIR}/${version}.${extension}"
+    if [[ -f "${path}" ]]; then
+      printf '%s\n' "${path}"
+      return 0
+    fi
+  done
+
+  return 1
+}
+
+trim_file() {
+  awk '
+    {
+      lines[NR] = $0
+    }
+    END {
+      start = 1
+      while (start <= NR && lines[start] ~ /^[[:space:]]*$/) {
+        start++
+      }
+
+      end = NR
+      while (end >= start && lines[end] ~ /^[[:space:]]*$/) {
+        end--
+      }
+
+      for (i = start; i <= end; i++) {
+        print lines[i]
+      }
+    }
+  ' "$1"
+}
+
 gh_read() {
   GH_TOKEN="${GH_READ_TOKEN}" gh "$@"
 }
@@ -165,15 +204,31 @@ if [[ "${manifest_at_merge}" != "${version}" || "${chart_version_at_merge}" != "
 fi
 
 notes_file="$(mktemp)"
-trap 'rm -f "${notes_file}"' EXIT
+generated_notes_file="$(mktemp)"
+trap 'rm -f "${notes_file}" "${generated_notes_file}"' EXIT
 
-jq -r '.body // empty' <<<"${release_pr_json}" | sanitize_release_notes > "${notes_file}"
+jq -r '.body // empty' <<<"${release_pr_json}" | sanitize_release_notes > "${generated_notes_file}"
 
-if [[ ! -s "${notes_file}" ]]; then
+if [[ ! -s "${generated_notes_file}" ]]; then
   echo "release PR #${release_pr_number} body is empty after sanitization" >&2
   exit 1
 fi
 
+if manual_notes_file="$(manual_release_notes_path "${version}")"; then
+  trim_file "${manual_notes_file}" > "${notes_file}"
+  if [[ -s "${notes_file}" ]]; then
+    printf '\n\n' >> "${notes_file}"
+  fi
+  cat "${generated_notes_file}" >> "${notes_file}"
+else
+  cat "${generated_notes_file}" > "${notes_file}"
+fi
+
+if [[ ! -s "${notes_file}" ]]; then
+  echo "release notes for ${version} are empty" >&2
+  exit 1
+fi
+
 if git rev-parse -q --verify "refs/tags/${version}" >/dev/null 2>&1; then
   local_tag_commit="$(git rev-list -n1 "${version}")"
   if [[ "${local_tag_commit}" != "${merge_oid}" ]]; then

website/versioned_docs/version-0.2.0/contribute/release-management.md

@@ -108,7 +108,7 @@ Release-please remains the source of truth for release notes. After release-plea
 
 <Callout type="note" title="Human release notes">
 
-Keep `CHANGELOG.md` generated by release-please. Put hand-written release summaries, migration notes, and operator-facing callouts in `release-notes/X.Y.Z.md`; the website release generator prepends that file to the generated changelog entry for the matching version.
+Keep `CHANGELOG.md` generated by release-please. Put hand-written release summaries, migration notes, and operator-facing callouts in `release-notes/X.Y.Z.md`; the website release generator and draft GitHub Release creation prepend that file to the generated changelog entry for the matching version.
 
 </Callout>