Improve release note layout: make it shorter with collapsable sections (netobserv#1146)

Author: jotak

Makefile

@@ -493,12 +493,15 @@ test-workflow: ## Run some tests on this Makefile and the github workflow
 .PHONY: related-release-notes
 related-release-notes: ## Grab release notes for related components (to be inserted in operator's release note upstream, cf RELEASE.md)
 	echo -e "## Related components\n\n" > /tmp/related.md
-	echo -e "### eBPF Agent\n\n" >> /tmp/related.md
-	curl -s  https://api.github.com/repos/netobserv/netobserv-ebpf-agent/releases/tags/$(BPF_VERSION) | jq -r .body | xargs -0 printf "%b" | sed -r "s/##/####/" >> /tmp/related.md
-	echo -e "### Flowlogs-Pipeline\n\n" >> /tmp/related.md
-	curl -s  https://api.github.com/repos/netobserv/flowlogs-pipeline/releases/tags/$(FLP_VERSION) | jq -r .body | xargs -0 printf "%b" | sed -r "s/##/####/" >> /tmp/related.md
-	echo -e "### Console Plugin\n\n" >> /tmp/related.md
-	curl -s  https://api.github.com/repos/netobserv/network-observability-console-plugin/releases/tags/$(PLG_VERSION) | jq -r .body | xargs -0 printf "%b" | sed -r "s/##/####/" >> /tmp/related.md
+	echo -e "<details><summary><b>eBPF Agent</b></summary>\n\n" >> /tmp/related.md
+	curl -s  https://api.github.com/repos/netobserv/netobserv-ebpf-agent/releases/tags/$(BPF_VERSION) | jq -r .body | xargs -0 printf "%b" | sed -r "s/##/###/" >> /tmp/related.md
+	echo -e "</details>\n" >> /tmp/related.md
+	echo -e "<details><summary><b>Flowlogs-Pipeline</b></summary>\n\n" >> /tmp/related.md
+	curl -s  https://api.github.com/repos/netobserv/flowlogs-pipeline/releases/tags/$(FLP_VERSION) | jq -r .body | xargs -0 printf "%b" | sed -r "s/##/###/" >> /tmp/related.md
+	echo -e "</details>\n" >> /tmp/related.md
+	echo -e "<details><summary><b>Console Plugin</b></summary>\n\n" >> /tmp/related.md
+	curl -s  https://api.github.com/repos/netobserv/network-observability-console-plugin/releases/tags/$(PLG_VERSION) | jq -r .body | xargs -0 printf "%b" | sed -r "s/##/###/" >> /tmp/related.md
+	echo -e "</details>\n" >> /tmp/related.md
 	wl-copy < /tmp/related.md
 	cat /tmp/related.md
 	echo -e "\nText has been copied to the clipboard.\n"

RELEASE.md

@@ -25,6 +25,18 @@ When the last release candidate is accepted and the final release tag is pushed
 
 Click the "Auto-generate release note" button.
 
+If you think the "Dependencies" section is too long, you can surround it in a `<details>` block, to make it collapsed. E.g:
+
+```yaml
+<details>
+<summary><b>Dependencies</b></summary>
+
+* Bump [...] from [...] by @dependabot in...
+* ...
+</details>
+```
+
+
 ### Operator
 
 Once all sub-components are released (or have a release candidate), we can proceed with the operator.
@@ -73,7 +85,18 @@ Grab related components release notes by running:
 make related-release-notes
 ```
 
-Then paste content following the auto-generated release note in GitHub.
+The script should fetch and copy the content in the clipboard. Paste it at the end of the auto-generated release note in GitHub.
+
+If you think the "Dependencies" section is too long, you can surround it in a `<details>` block, to make it collapsed. E.g:
+
+```yaml
+<details>
+<summary><b>Dependencies</b></summary>
+
+* Bump github.com/netobserv/flowlogs-pipeline from [...] by @dependabot in...
+* ...
+</details>
+```
 
 Check the "Create a discussion for this release" option, in category "Announcements".