fix issues with the release docs workflow (#10315)

* fix issues with the release workflow and update tech specs json

* add column count validation

* update index.md text and remove unnecessary rows from tech-specs.json

* add check to determine upgrade section title

---------

Co-authored-by: Venktesh Patel <ve.patel@f5.com>

Author: spencerugbo

.github/scripts/pull-release-notes.py

@@ -11,10 +11,12 @@
 # parse args
 parser = argparse.ArgumentParser()
 parser.add_argument("nic_version", help="NGINX Ingress Controller version")
+parser.add_argument("previous_version", help="Previous NGINX Ingress Controller version")
 parser.add_argument("helm_chart_version", help="NGINX Ingress Controller Helm chart version")
 parser.add_argument("k8s_versions", help="Kubernetes versions")
 parser.add_argument("release_date", help="Release date")
 args = parser.parse_args()
+OLD_VERSION = args.previous_version
 NIC_VERSION = args.nic_version
 HELM_CHART_VERSION = args.helm_chart_version
 K8S_VERSIONS = args.k8s_versions
@@ -103,9 +105,9 @@ def format_pr_groups(prs, title):
 
 # Get release text
 def get_github_release(version, github_org, github_repo, token):
-    if token == "":
+    if not token:
         print("ERROR: GITHUB token variable cannot be empty")
-        return None
+        return None, None
     auth = Auth.Token(token)
     g = Github(auth=auth)
     repo = g.get_organization(github_org).get_repo(github_repo)
@@ -148,18 +150,28 @@ def get_pr_labels(repo, pr_number):
 # and format them accordingly
 categories = {}
 dependencies_title = ""
+go_dependencies = []
+docker_dependencies = []
 for title, changes in sections.items():
-    if any(x in title for x in ["Other Changes", "Documentation", "Maintenance", "Tests"]):
+    if any(x in title for x in ["Other Changes", "Documentation", "Maintenance", "Tests", "New Contributors"]):
         # These sections do not show up in the docs release notes
         continue
     parsed_changes = []
-    go_dependencies = []
-    docker_dependencies = []
     for line in changes:
         change = re.search(change_regex, line)
+        if not change:
+            print(f"WARNING: Skipping unrecognized line: {line}")
+            continue
         change_title = change.group(1)
         pr_link = change.group(2)
-        pr_number = re.search(pull_request_regex, pr_link).group(1)
+        pr_links = re.findall(r"https://github\.com/\S+/pull/\d+", pr_link)
+        if pr_links:
+            pr_link = pr_links[-1]
+        pr_match = re.search(pull_request_regex, pr_link)
+        if not pr_match:
+            print(f"WARNING: Could not extract PR number from: {pr_link}")
+            continue
+        pr_number = pr_match.group(1)
         pr = {"details": f"[{pr_number}]({pr_link})", "title": change_title.capitalize()}
         if "Dependencies" in title:
             # save section title for later use as lookup key to categories dict
@@ -216,6 +228,11 @@ def get_pr_labels(repo, pr_number):
         categories[dependencies_title].append(format_pr_groups(go_dependencies, "Bump Go dependencies"))
     categories[dependencies_title].reverse()
 
+# Check if version is a patch release or a minor/major release
+old_version_parts = OLD_VERSION.split(".")
+new_version_parts = NIC_VERSION.split(".")
+is_upgrade = old_version_parts[0] != new_version_parts[0] or old_version_parts[1] != new_version_parts[1]
+
 # Populates the data needed for rendering the template
 # The data will be passed to the Jinja2 template for rendering
 data = {
@@ -224,6 +241,7 @@ def get_pr_labels(repo, pr_number):
     "sections": categories,
     "HELM_CHART_VERSION": HELM_CHART_VERSION,
     "K8S_VERSIONS": K8S_VERSIONS,
+    "upgrade_label": "Upgrade" if is_upgrade else "Update",
 }
 
 # Render with Jinja2

.github/scripts/release-docs.sh

@@ -14,7 +14,7 @@ RELEASE_BRANCH_PREFIX=${RELEASE_BRANCH_PREFIX:-"nic-release-"}
 export GH_TOKEN=${GITHUB_TOKEN:-""}
 
  usage() {
-    echo "Usage: $0 <ic_version> <helm_chart_version> <operator_version> <k8s_versions> <nginx_version> <release_date> [<nap_waf_version>] [<nap_waf_release_version>]"
+    echo "Usage: $0 <ic_version> <previous_version> <helm_chart_version> <operator_version> <k8s_versions> <nginx_version> <release_date> [<nap_waf_version>] [<nap_waf_release_version>]"
     exit 1
  }
 
@@ -23,18 +23,23 @@ export GH_TOKEN=${GITHUB_TOKEN:-""}
 
 DOCS_FOLDER=${TMPDIR}/documentation
 ic_version=$1
-helm_chart_version=$2
-operator_version=$3
-k8s_versions=$4
-nginx_version=$5
-release_date=$6
-NAP_WAF_VERSION=${7:-}
-NAP_WAF_RELEASE_VERSION=${8:-}
+previous_version=$2
+helm_chart_version=$3
+operator_version=$4
+k8s_versions=$5
+nginx_version=$6
+release_date=$7
+NAP_WAF_VERSION=${8:-}
+NAP_WAF_RELEASE_VERSION=${9:-}
 
 if [ -z "${ic_version}" ]; then
     usage
 fi
 
+if [ -z "${previous_version}" ]; then
+    usage
+fi
+
 if [ -z "${helm_chart_version}" ]; then
     usage
 fi
@@ -83,6 +88,7 @@ if [ "${DEBUG}" != "false" ]; then
     echo "DEBUG: GH_TOKEN: ****$(echo -n $GH_TOKEN | tail -c 4)"
     echo "DEBUG: DOCS_FOLDER: ${DOCS_FOLDER}"
     echo "DEBUG: ic_version: ${ic_version}"
+    echo "DEBUG: previous_version: ${previous_version}"
     echo "DEBUG: helm_chart_version: ${helm_chart_version}"
     echo "DEBUG: operator_version: ${operator_version}"
     echo "DEBUG: k8s_versions: ${k8s_versions}"
@@ -93,7 +99,7 @@ if [ "${DEBUG}" != "false" ]; then
 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}")
+release_notes_content=$("${ROOTDIR}"/.github/scripts/pull-release-notes.py "${ic_version}" "${previous_version}" "${helm_chart_version}" "${k8s_versions}" "${release_date}")
 if [ $? -ne 0 ]; then
     echo "ERROR: failed to fetch release notes from GitHub draft release for version ${ic_version}"
     exit 2
@@ -180,11 +186,11 @@ 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"
+# Second: if that fails, look for year in release date entries
 if [ -z "${current_year}" ]; then
-    current_year=$(grep -o "^## .*[0-9]\{4\}" "${index_file_path}" | grep -o "[0-9]\{4\}" | head -1)
+    current_year=$(grep -oE "[0-9]{1,2} [A-Z][a-z]+ [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}"
+        echo "DEBUG: Found year in release date entries: ${current_year}"
     fi
 fi
 
@@ -329,6 +335,7 @@ if [ -n "${nginx_version}" ]; then
     # Run the consolidated tech specs update script (driven by tech-specs.json)
     python3 ${ROOTDIR}/.github/scripts/tech-specs-update.py \
         --json-file "${ROOTDIR}/.github/scripts/tech-specs.json" \
+        --update-json \
         "${ic_version}" "${k8s_versions}" "${nginx_version}" "${DOCS_FOLDER}" \
         ${NAP_WAF_VERSION:+"${NAP_WAF_VERSION}"}
 

.github/scripts/release-notes.j2

@@ -28,12 +28,12 @@
 {%- endif %}
 {%- endfor %}
 
-### {{ '{{% icon download %}' }}{{ '}' }} Upgrade
+### {{ '{{% icon download %}' }}{{ '}' }} {{ upgrade_label }}
 
-- 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 NGINX, use the {{ version }} images from [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 from the {{ version }} source code.
 - For Helm, use version {{ HELM_CHART_VERSION }} of the chart.
 
 ### {{ '{{% 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 }}.
+We 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 }}.

.github/scripts/tech-specs-update.py

@@ -23,7 +23,6 @@
 import json
 import re
 import sys
-from datetime import datetime
 from pathlib import Path
 
 # ---------------------------------------------------------------------------
@@ -140,7 +139,7 @@ def update_nap_sc_row(sc_row, nap_waf_version):
     """
     if nap_waf_version and "+" in nap_waf_version:
         new_prefix = nap_waf_version.split("+")[0]
-        m = re.search(r"(\d+)\+", sc_row)
+        m = re.search(r"(\d+(?:\.\d+)*)\+", sc_row)
         if m and m.group(1) != new_prefix:
             return sc_row.replace(m.group(1) + "+", new_prefix + "+", 1)
     return sc_row
@@ -171,56 +170,35 @@ def generate_compat_table_md(json_data, sc_row=None):
     used as-is to preserve original formatting.  Otherwise a fresh shortcode
     row is generated from the JSON shortcode_row values.
 
-    Prunes rows past their End of Technical Support date, keeping the most
-    recently expired row as a reference.
     """
     sr = json_data["nic_k8s"]["shortcode_row"]
     rows = json_data["nic_k8s"]["rows"]
 
+    if sc_row is not None:
+        col_count = len(sc_row.split("|")[1:-1])
+        if col_count != 5:
+            sc_row = None
+
     header = (
         "| NIC version | Kubernetes versions tested  "
         "| NIC Helm Chart version | NIC Operator version "
-        "| NGINX / NGINX Plus version | End of Technical Support |"
+        "| NGINX / NGINX Plus version |"
     )
-    sep = "| --- | --- | --- | --- | --- | --- |"
+    sep = "| --- | --- | --- | --- | --- |"
 
     if sc_row is None:
         sc_row = (
             f"| {{{{< nic-version >}}}} | {sr['k8s_versions']} "
             f"| {{{{< nic-helm-version >}}}} | {{{{< nic-operator-version >}}}} "
-            f"| {sr['nginx_version']} | - |"
+            f"| {sr['nginx_version']} |"
         )
 
-    # EOTS pruning
-    now = datetime.now()
-    active_rows = []
-    expired_rows = []
-    for row in rows:
-        eots = row.get("eots_date", "-")
-        if eots and eots != "-":
-            try:
-                eots_date = datetime.strptime(eots, "%b %d, %Y")
-                if now > eots_date:
-                    expired_rows.append((eots_date, row))
-                    continue
-            except ValueError:
-                # End of Technical Support value doesn't match expected date format — keep the row rather than pruning it.
-                print(
-                    f"WARNING: Could not parse End of Technical Support date '{eots}' for NIC version '{row.get('nic_version', 'unknown')}', keeping row"
-                )
-        active_rows.append(row)
-
-    # Keep the most recently expired row as a migration reference
-    if expired_rows:
-        expired_rows.sort(key=lambda x: x[0], reverse=True)
-        active_rows.append(expired_rows[0][1])
-
     data_lines = []
-    for row in active_rows:
+    for row in rows:
         data_lines.append(
             f"| {row['nic_version']} | {row['k8s_versions']} "
             f"| {row['helm_version']} | {row['operator_version']} "
-            f"| {row['nginx_version']} | {row['eots_date']} |"
+            f"| {row['nginx_version']} |"
         )
 
     return "\n".join([header, sep, sc_row] + data_lines)
@@ -303,14 +281,14 @@ def update_nginx_prose(md, nginx_new):
         if oss_match:
             current_oss = oss_match.group(1)
             if current_oss != new_oss:
-                md = re.sub(r"\b" + re.escape(current_oss) + r"\b", new_oss, md)
+                md = re.sub(r"\b" + re.escape(current_oss) + r"(?!\.?\d)", new_oss, md)
 
     if new_plus:
-        plus_match = re.search(r"NGINX Plus images include NGINX Plus (R\d+(?:\s+P\d+)?)", md)
+        plus_match = re.search(r"NGINX Plus images include NGINX Plus (R\d+(?:\.\d+)*(?:\s+P\d+)?)", md)
         if plus_match:
             current_plus = plus_match.group(1)
             if current_plus != new_plus:
-                md = re.sub(r"\b" + re.escape(current_plus) + r"\b", new_plus, md)
+                md = re.sub(r"\b" + re.escape(current_plus) + r"(?!\.?\d)", new_plus, md)
 
     return md
 
@@ -340,7 +318,6 @@ def freeze_compat_row(json_data, current_nic, current_helm, current_operator):
         "helm_version": current_helm,
         "operator_version": current_operator,
         "nginx_version": sr["nginx_version"],
-        "eots_date": "-",
     }
     json_data["nic_k8s"]["rows"].insert(0, frozen)
     print(f"INFO: Frozen compat row for {current_nic}")