瀏覽代碼

Enhance release notes formatting and improve branch display in render script

TheWildJames 3 月之前
父節點
當前提交
b29463a5f0
共有 2 個文件被更改,包括 25 次插入24 次删除
  1. 21 22
      .github/config/RELEASE_NOTES.md
  2. 4 2
      .github/scripts/render_release_body.py

+ 21 - 22
.github/config/RELEASE_NOTES.md

@@ -1,25 +1,31 @@
 **IMPORTANT DISCLAIMER**
 
-This software is provided for testing and educational purposes only. Use at your own risk.
-The developers are not responsible for any damage, data loss, or issues that may occur.
-Please ensure you have proper backups before installation.
+> [!CAUTION]
+> This software is provided for testing and educational purposes only. Use at your own risk. The developers are not responsible for any damage, data loss, or issues that may occur. Please ensure you have proper backups before installation.
 
-## KernelSU-Next
+---
+
+## [KernelSU-Next](https://github.com/KernelSU-Next/KernelSU-Next)
 
 A kernel-based root solution for Android devices.
 
-- Version: {{KSU_VERSION}}
-- Tag: {{KSU_GIT_TAG}}
-- Branch: {{KSUN_BRANCH}}
-- Commit: {{KSUN_COMMIT}}
+> [!IMPORTANT]
+> For best compatiblity ensure your Manager Version and Kernel Version match eg. 30100 = 30100.
+
+| :---     |      :---:      |
+| Version: | {{KSU_VERSION}} |
+| Tag:     | {{KSU_GIT_TAG}} |
+| Branch:  | {{KSUN_BRANCH}} |
+| Commit:  | {{KSUN_COMMIT}} |
 
-- URL: https://github.com/KernelSU-Next/KernelSU-Next
 - Manager: {{KSU_MANAGER}}
 
-## SUSFS
+## [SUSFS v2.1.0](https://gitlab.com/simonpunk/susfs4ksu)
 
 A KSU addon for hiding root using kernel patches and a userspace module!
 
+Reccomended Module: [susfs4ksu-module by sidex15](https://github.com/sidex15/susfs4ksu-module)
+
 - SUS_PATH - Hide suspicious paths
 - SUS_MOUNT - Hide mount points (no CLI support)
 - SUS_KSTAT - Spoof kernel statistics
@@ -32,23 +38,18 @@ A KSU addon for hiding root using kernel patches and a userspace module!
 - Version: v2.1.0
 - Branches:
 
+| Branch | Commit |
+| :--- | :---: |
 {{SUSFS_BRANCHES}}
 
-- URL: https://gitlab.com/simonpunk/susfs4ksu
-
-## Baseband Guard (BBG)
+## [Baseband Guard (BBG)](https://github.com/vc-teahouse/Baseband-guard)
 
 LSM-based baseband security
 
-- Branch: main
-- URL: https://github.com/vc-teahouse/Baseband-guard
-
-## DroidSpaces
+## [DroidSpaces-OSS](https://github.com/ravindu644/Droidspaces-OSS)
 
 A lightweight, LXC-inspired container runtime for Android and Linux. Run full Linux distributions natively with zero performance penalty
 
-- URL: https://github.com/ravindu644/Droidspaces-OSS
-
 ## Networking
 
 - BBRv1 - Improved TCP congestion control
@@ -61,12 +62,10 @@ A lightweight, LXC-inspired container runtime for Android and Linux. Run full Li
 - TMPFS_XATTR - Extended attributes for tmpfs (Mountify support)
 - TMPFS_POSIX_ACL - POSIX ACLs for tmpfs
 
-## Kernel Flasher
+## [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher)
 
 Recommended flashing utility
 
-- URL: https://github.com/fatalcoder524/KernelFlasher
-
 ## Installation Instructions
 
 ### Prerequisites

+ 4 - 2
.github/scripts/render_release_body.py

@@ -24,7 +24,7 @@ def render_markdown(template_path: Path):
 
     susfs_branches = []
     for branch, commit in commits.get("susfs", {}).items():
-        susfs_branches.append(f"  - {branch}: {commit}")
+        susfs_branches.append(f"| {branch} | {commit} |")
 
     if "{{SUSFS_BRANCHS}}" in text:
         text = text.replace("{{SUSFS_BRANCHS}}", "\n".join(susfs_branches))
@@ -101,8 +101,10 @@ for key in data.keys():
 
     if key == "susfs" and "susfs" in commits:
         emit("- Branches:")
+        emit("| Branch | Commit |")
+        emit("| :--- | :---: |")
         for branch, commit in commits["susfs"].items():
-            emit(f"  - {branch}: {commit}")
+            emit(f"| {branch} | {commit} |")
 
     if section.get("items"):
         emit_list(section["items"])