Update automated release docs to match previous version (#8591)

AlexFenlon · web-flow · commit 042c18473172 · 2025-12-02T12:10:23.000Z
diff --git a/.github/scripts/pull-release-notes.py b/.github/scripts/pull-release-notes.py
@@ -116,7 +116,7 @@ def get_github_release(version, github_org, github_repo, token):
 # We will create a dictionary with the categories and their changes
 # Also, we will handle dependencies separately for Go and Docker images
 # and format them accordingly
-catagories = {}
+categories = {}
 dependencies_title = ""
 for title, changes in sections.items():
     if any(x in title for x in ["Other Changes", "Documentation", "Maintenance", "Tests"]):
@@ -147,19 +147,20 @@ def get_github_release(version, github_org, github_repo, token):
         else:
             parsed_changes.append(f"{pr['details']} {pr['title']}")
 
-    catagories[title] = parsed_changes
+    categories[title] = parsed_changes
 
 # Add grouped dependencies to the Dependencies category
-catagories[dependencies_title].append(format_pr_groups(docker_dependencies, "Bump Docker dependencies"))
-catagories[dependencies_title].append(format_pr_groups(go_dependencies, "Bump Go dependencies"))
-catagories[dependencies_title].reverse()
+if dependencies_title:
+    categories[dependencies_title].append(format_pr_groups(docker_dependencies, "Bump Docker dependencies"))
+    categories[dependencies_title].append(format_pr_groups(go_dependencies, "Bump Go dependencies"))
+    categories[dependencies_title].reverse()
 
 # Populates the data needed for rendering the template
 # The data will be passed to the Jinja2 template for rendering
 data = {
     "version": NIC_VERSION,
     "release_date": RELEASE_DATE,
-    "sections": catagories,
+    "sections": categories,
     "HELM_CHART_VERSION": HELM_CHART_VERSION,
     "K8S_VERSIONS": K8S_VERSIONS,
 }
diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh
@@ -77,7 +77,7 @@ fi
 echo "INFO: Generating release notes from github draft release"
 release_notes_content=$(${ROOTDIR}/.github/scripts/pull-release-notes.py ${ic_version} ${helm_chart_version} ${k8s_versions} "${release_date}")
 if [ $? -ne 0 ]; then
-    echo "ERROR: failed processing release notes"
+    echo "ERROR: failed to fetch release notes from GitHub draft release for version ${ic_version}"
     exit 2
 fi
 
@@ -86,6 +86,9 @@ if [ -z "${release_notes_content}" ]; then
     exit 2
 fi
 
+# Fix HTML entity encoding issues that happen when converting github draft to .md
+release_notes_content=$(echo "${release_notes_content}" | sed 's/&amp;/\&/g' | sed 's/&lt;/</g' | sed 's/&gt;/>/g' | sed 's/&quot;/"/g' | sed 's/&#34;/"/g')
+
 if [ "${DEBUG}" != "false" ]; then
     echo "DEBUG: Release notes content:"
     echo "${release_notes_content}"
@@ -113,10 +116,10 @@ if [ "${DEBUG}" != "false" ]; then
     echo "DEBUG: Cloned doc repo to ${DOCS_FOLDER} and changed directory"
 fi
 
-# generate branch name
+# Generate branch name using major.minor version (e.g., nic-release-5.2)
 branch=${RELEASE_BRANCH_PREFIX}${ic_version%.*}
 if [ "${DEBUG}" != "false" ]; then
-    echo "DEBUG: Generating branch ${branch}"
+    echo "DEBUG: Generated branch name: ${branch} (from version ${ic_version})"
 fi
 
 echo "INFO: Checking out branch ${branch} in the documentation repository"
@@ -125,29 +128,173 @@ remote_branch=$(git ls-remote --heads origin ${branch} 2> /dev/null)
 if [ -n "${remote_branch}" ]; then
     git checkout ${branch}
     if [ "${DEBUG}" != "false" ]; then
-        echo "DEBUG: Checked out branch ${branch}"
+        echo "DEBUG: Checked out existing branch ${branch}"
     fi
 else
     git checkout -b ${branch}
     if [ "${DEBUG}" != "false" ]; then
-        echo "DEBUG: Created branch ${branch}"
+        echo "DEBUG: Created new branch ${branch}"
     fi
 fi
 
-echo "INFO: Adding release notes content to release.md in the documentation repository"
-file_path=${DOCS_FOLDER}/content/nic/releases.md
+# Extract year from release date
+release_year=$(date -j -f "%d %b %Y" "${release_date}" "+%Y" 2>/dev/null || date -d "${release_date}" "+%Y" 2>/dev/null)
+
+if [ -z "${release_year}" ]; then
+    echo "ERROR: failed to parse release year from date: ${release_date}"
+    exit 2
+fi
+
+# Determine what year the current _index.md represents
+index_file_path=${DOCS_FOLDER}/content/nic/changelog/_index.md
+
 if [ "${DEBUG}" != "false" ]; then
-    echo "DEBUG: Processing ${file_path}"
-fi
-file_name=$(basename "${file_path}")
-mv "${file_path}" "${TMPDIR}/${file_name}"
-head -n 8 "${TMPDIR}/${file_name}" > "${TMPDIR}/header"
-tail -n +9 "${TMPDIR}/${file_name}" > "${TMPDIR}/body"
-echo "${release_notes_content}" > "${TMPDIR}/release_notes"
-cat "${TMPDIR}/header" "${TMPDIR}/release_notes" "${TMPDIR}/body" > "${file_path}"
+    echo "DEBUG: Attempting to detect current changelog year from ${index_file_path}"
+fi
+
+# First: look for "releases in 2025" in the header
+current_year=$(grep "releases in" "${index_file_path}" | grep -o "[0-9]\{4\}" | head -1)
+if [ "${DEBUG}" != "false" ] && [ -n "${current_year}" ]; then
+    echo "DEBUG: Found year in header text: ${current_year}"
+fi
+
+# Second: if that fails, look for year in release headings like "## 5.2.1"
+if [ -z "${current_year}" ]; then
+    current_year=$(grep -o "^## .*[0-9]\{4\}" "${index_file_path}" | grep -o "[0-9]\{4\}" | head -1)
+    if [ "${DEBUG}" != "false" ] && [ -n "${current_year}" ]; then
+        echo "DEBUG: Found year in release headings: ${current_year}"
+    fi
+fi
+
+# Third: if both fail, assume it's the previous year as a safe fallback
+if [ -z "${current_year}" ]; then
+    current_year=$((release_year - 1))
+    if [ "${DEBUG}" != "false" ]; then
+        echo "DEBUG: No year found in changelog, using fallback: ${current_year}"
+    fi
+fi
+
+if [ "${DEBUG}" != "false" ]; then
+    echo "DEBUG: Current index year: ${current_year}, Release year: ${release_year}"
+fi
+
+# Compare release year vs current index year
+# If different years: archive current year's releases and create new index
+# If same year: just add to existing index
+if [ "${release_year}" != "${current_year}" ]; then
+    # New year - archive current year and start fresh
+    echo "INFO: New year detected (${release_year}). Archiving ${current_year} and creating new index."
+
+    # Create archive file with Hugo frontmatter for the current year's releases
+    archive_file=${DOCS_FOLDER}/content/nic/changelog/${current_year}.md
+    cp "${index_file_path}" "${TMPDIR}/temp_index.md"
+
+    # Update weights in existing archive files (bump each by 100 to make room for new archive at 100)
+    if [ "${DEBUG}" != "false" ]; then
+        echo "DEBUG: Updating weights in existing archive files"
+    fi
+    for existing_archive in ${DOCS_FOLDER}/content/nic/changelog/[0-9][0-9][0-9][0-9].md; do
+        if [ -f "${existing_archive}" ]; then
+            # Extract current weight and add 100
+            current_weight=$(grep "^weight:" "${existing_archive}" | sed 's/^weight:[[:space:]]*//')
+            new_weight=$((current_weight + 100))
+            sed -i.bak "s/^weight: *${current_weight}/weight: ${new_weight}/" "${existing_archive}"
+            rm -f "${existing_archive}.bak"
+            if [ "${DEBUG}" != "false" ]; then
+                echo "DEBUG: Updated $(basename "${existing_archive}") weight from ${current_weight} to ${new_weight}"
+            fi
+        fi
+    done
+
+    # Create archive with frontmatter
+    cat > "${archive_file}" << EOF
+---
+title: "${current_year} archive"
+# Weights are assigned in increments of 100: determines sorting order
+weight: 100
+# Creates a table of contents and sidebar, useful for large documents
+toc: true
+# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
+nd-content-type: reference
+nd-product: INGRESS
+---
+
+EOF
+
+    # Find where releases start (first "## " heading) and copy everything after that
+    # This skips the frontmatter and intro text, keeping only actual release entries
+    release_start=$(grep -n "^## " "${TMPDIR}/temp_index.md" | head -1 | cut -d: -f1)
+    if [ "${DEBUG}" != "false" ]; then
+        echo "DEBUG: Release content starts at line: ${release_start:-'not found'}"
+    fi
+    [ -n "${release_start}" ] && tail -n +${release_start} "${TMPDIR}/temp_index.md" >> "${archive_file}"
+
+    # Create new index for new year
+    echo "INFO: Creating new _index.md for year ${release_year}"
+
+    # Extract header content (everything before the newest release) and update year references
+    if [ "${DEBUG}" != "false" ]; then
+        echo "DEBUG: Extracting header and updating year references from ${current_year} to ${release_year}"
+    fi
+
+    if [ -n "${release_start}" ]; then
+        # Extract everything before the newest release heading
+        head -n $((release_start - 1)) "${TMPDIR}/temp_index.md"
+    else
+        # No releases found, extract most of the file (excluding footer)
+        head -n $(($(wc -l < "${TMPDIR}/temp_index.md") - 3)) "${TMPDIR}/temp_index.md"
+    fi | sed "s/${current_year}/${release_year}/g" | awk -v archived_year="${current_year}" '
+    # Add the archived year to the "previous years" link list
+    /For older releases, check the changelogs for previous years:/ {
+        # Insert the archived year at the beginning
+        sub(/For older releases, check the changelogs for previous years: /, "For older releases, check the changelogs for previous years: [" archived_year "]({{< ref \"/nic/changelog/" archived_year ".md\" >}}), ")
+    }
+    { print }
+    ' > "${TMPDIR}/new_header.md"
+
+    # Assemble new index file: header + new release notes
+    if [ "${DEBUG}" != "false" ]; then
+        echo "DEBUG: Assembling new _index.md with header and new release notes"
+    fi
+    cat "${TMPDIR}/new_header.md" > "${index_file_path}"
+    echo "" >> "${index_file_path}"
+    echo "${release_notes_content}" >> "${index_file_path}"
+
+else
+    # Same year - add to existing changelog
+    echo "INFO: Adding release notes to existing changelog/_index.md for year ${release_year}"
+
+    # Find where to insert new release notes in existing changelog
+    # Look for first release heading ("## ") or fallback to after compatibility matrix
+    cp "${index_file_path}" "${TMPDIR}/temp_index.md"
+    insert_line=$(grep -n "^## " "${TMPDIR}/temp_index.md" | head -1 | cut -d: -f1)
+
+    if [ -z "${insert_line}" ]; then
+        # No existing releases found, insert after the compatibility matrix
+        if [ "${DEBUG}" != "false" ]; then
+            echo "DEBUG: No existing releases found, looking for {{< /details >}} tag"
+        fi
+        insert_line=$(grep -n "{{< /details >}}" "${TMPDIR}/temp_index.md" | tail -1 | cut -d: -f1)
+        [ -n "${insert_line}" ] && insert_line=$((insert_line + 2)) || insert_line=8
+    fi
+
+    if [ "${DEBUG}" != "false" ]; then
+        echo "DEBUG: Will insert new release at line ${insert_line}"
+    fi
+
+    # Reconstruct the file: header + new release + existing releases
+    # This inserts the new release at the top of the releases section
+    head -n $((insert_line - 1)) "${TMPDIR}/temp_index.md" > "${TMPDIR}/final_index.md"
+    echo "" >> "${TMPDIR}/final_index.md"
+    echo "${release_notes_content}" >> "${TMPDIR}/final_index.md"
+    echo "" >> "${TMPDIR}/final_index.md"
+    tail -n +${insert_line} "${TMPDIR}/temp_index.md" >> "${TMPDIR}/final_index.md"
+
+    mv "${TMPDIR}/final_index.md" "${index_file_path}"
+fi
+
 if [ $? -ne 0 ]; then
-    echo "ERROR: failed processing ${file_path}"
-    mv "${TMPDIR}/${file_name}" "${file_path}"
+    echo "ERROR: failed processing changelog files"
     exit 2
 fi
 
@@ -158,20 +305,21 @@ if [ $? -ne 0 ]; then
     exit 2
 fi
 
-echo "INFO: Committing changes to the documentation repository"
+echo "INFO: Staging changes for commit"
 git add -A
 if [ $? -ne 0 ]; then
     echo "ERROR: failed adding files to git"
     exit 2
 fi
 
-git commit -m "Update release notes for ${ic_version}"
-if [ $? -ne 0 ]; then
-    echo "ERROR: failed committing changes to the docs repo"
-    exit 2
-fi
-
 if [ "${DRY_RUN}" == "false" ]; then
+    echo "INFO: Committing changes to the documentation repository"
+    git commit -m "Update release notes for ${ic_version}"
+    if [ $? -ne 0 ]; then
+        echo "ERROR: failed committing changes to the docs repo"
+        exit 2
+    fi
+
     echo "INFO: Pushing changes to the documentation repository"
     git push origin ${branch}
     if [ $? -ne 0 ]; then
@@ -181,7 +329,9 @@ if [ "${DRY_RUN}" == "false" ]; then
     echo "INFO: Creating pull request for the documentation repository"
     gh pr create --title "Update release notes for ${ic_version}" --body "Update release notes for ${ic_version}" --head ${branch} --draft
 else
-    echo "INFO: DRY_RUN: Skipping push and pull request creation"
+    echo "INFO: DRY_RUN: Showing what would be committed:"
+    git status --porcelain
+    echo "INFO: DRY_RUN: Skipping commit, push and pull request creation"
 fi
 
 if [ "${DEBUG}" != "false" ]; then
@@ -191,7 +341,9 @@ cd - > /dev/null 2>&1
 
 if [ "${TIDY}" == "true" ]; then
     echo "INFO: Clean up"
-    rm -rf "${TMPDIR}/header" "${TMPDIR}/body" "${TMPDIR}/release_notes" "${DOCS_FOLDER}"
+    rm -rf "${TMPDIR}/temp_index.md" "${TMPDIR}/final_index.md" "${TMPDIR}/current_index.md" "${TMPDIR}/new_header.md" "${DOCS_FOLDER}"
+else
+    echo "INFO: Skipping tidy (docs folder: ${DOCS_FOLDER})"
 fi
 
 exit 0
diff --git a/.github/scripts/release-notes.j2 b/.github/scripts/release-notes.j2
@@ -10,28 +10,27 @@
   'Dependencies': '⬆️ Dependencies'
 } %}
 {%- set icons = {
-  'Breaking Changes': 'fa-bomb',
-  'Features': 'fa-rocket',
-  'Fixes': 'fa-bug-slash',
-  'Helm Chart': 'fa-box',
-  'Dependencies': 'fa-upload'
+  'Breaking Changes': 'bomb',
+  'Features': 'rocket',
+  'Fixes': 'bug',
+  'Helm Chart': 'package',
+  'Dependencies': 'arrow-up'
 } %}
 {%- for category, key in category_map.items() %}
-{%- if sections.get(key) %}
+{%- if sections.get(category) or sections.get(key) %}
+{%- set section_data = sections.get(category, sections.get(key, [])) %}
 
-### <i class="fa-solid {{ icons[category] }}"></i> {{ category }}
-{%- for change in sections[key] %}
+### {{ '{{% icon ' + icons[category] + ' %}' }}{{ '}' }} {{ category }}
+{%- for change in section_data %}
 - {{ change }}
 {%- endfor %}
 {%- endif %}
 {%- endfor %}
 
-### <i class="fa-solid fa-download"></i> Upgrade
+### {{ '{{% icon download %}' }}{{ '}' }} Upgrade
 - For NGINX, use the {{ version }} images from our [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/tags?page=1&ordering=last_updated&name={{ version }}), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress).
 - For NGINX Plus, use the {{ version }} images from the F5 Container registry or build your own image using the {{ version }} source code.
 - For Helm, use version {{ HELM_CHART_VERSION }} of the chart.
 
-### <i class="fa-solid fa-life-ring"></i> Supported Platforms
+### {{ '{{% icon life-buoy %}' }}{{ '}' }} Supported Platforms
 We will provide technical support for NGINX Ingress Controller on any Kubernetes platform that is currently supported by its provider and that passes the Kubernetes conformance tests. This release was fully tested on the following Kubernetes versions: {{ K8S_VERSIONS }}.
-
----
