From 64814e316c03b45a6dd06eedc23d6e9085c0f63e Mon Sep 17 00:00:00 2001
From: Vaclav Petras <wenzeslaus@gmail.com>
Date: Sat, 15 Jun 2024 11:36:13 -0400
Subject: [PATCH] contributing: Hide bots from release notes (#3829)

This hides all changes by recognized bots from release notes. The changes may still be relevant, e.g., change of version of dependency in a Docker image, so they are hidden but discoverable using Markdown details HTML tag.

Additionally, to make the release notes shorter, this shows only 20 items and hides the rest together with the changes from bots. The overflowing changes are printed first, then the ones from bots. Each group is sorted alphabetically.
---
 utils/generate_release_notes.py | 21 +++++++++++++++++++++
 utils/known_bot_names.txt       |  1 +
 2 files changed, 22 insertions(+)
 create mode 100644 utils/known_bot_names.txt

diff --git a/utils/generate_release_notes.py b/utils/generate_release_notes.py
index bf04db5d7c5..3e6367d39cc 100755
--- a/utils/generate_release_notes.py
+++ b/utils/generate_release_notes.py
@@ -7,6 +7,7 @@
 
 import argparse
 import csv
+import itertools
 import json
 import re
 import subprocess
@@ -81,8 +82,28 @@ def print_category(category, changes, file=None):
     if not items:
         return
     print_section_heading_3(category, file=file)
+    bot_file = Path("utils") / "known_bot_names.txt"
+    known_bot_names = bot_file.read_text().splitlines()
+    visible = []
+    hidden = []
+    overflow = []
+    max_section_length = 25
     for item in sorted(items):
+        author = item.rsplit(" by ", maxsplit=1)[-1]
+        if author in known_bot_names or author.endswith("[bot]"):
+            hidden.append(item)
+        elif len(visible) > max_section_length:
+            overflow.append(item)
+        else:
+            visible.append(item)
+    for item in visible:
         print(f"* {item}", file=file)
+    if hidden:
+        print("\n<details>")
+        print(" <summary>Show more</summary>\n")
+        for item in itertools.chain(overflow, hidden):
+            print(f"  * {item}", file=file)
+        print("\n</details>")
     print("")
 
 
diff --git a/utils/known_bot_names.txt b/utils/known_bot_names.txt
new file mode 100644
index 00000000000..99a0ff600bc
--- /dev/null
+++ b/utils/known_bot_names.txt
@@ -0,0 +1 @@
+osgeoweblate