fix: 重新调整数据显示顺序和文本 (#333)

nonebot · Dec 20, 2024 · d718bff · d718bff
1 parent 0034f67
commit d718bff
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 28 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/lang/zh-CN/
 
 ## [Unreleased]
 
+### Fixed
+
+- 重新调整数据显示顺序和文本
+
 ## [4.2.1] - 2024-12-20
 
 ### Fixed

diff --git a/src/plugins/github/plugins/publish/constants.py b/src/plugins/github/plugins/publish/constants.py
@@ -59,6 +59,6 @@
     "supported_adapters": "插件支持的适配器",
     "metadata": "插件测试元数据",
     "load": "插件是否成功加载",
-    "version": "插件版本号",
-    "time": "插件发布时间",
+    "version": "版本号",
+    "time": "发布时间",
 }
diff --git a/src/plugins/github/plugins/publish/render.py b/src/plugins/github/plugins/publish/render.py
@@ -69,33 +69,34 @@ async def render_comment(result: ValidationDict, reuse: bool = False) -> str:
     """将验证结果转换为评论内容"""
     title = f"{result.type}: {result.name}"
 
+    valid_data = result.valid_data.copy()
+
+    if result.type == PublishType.PLUGIN:
+        # https://github.com/he0119/action-test/actions/runs/4469672520
+        # 仅在测试通过或跳过测试时显示
+        # 如果 load 为 False 的时候 valid_data 里面没有 load 字段，所以直接用 raw_data
+        if result.raw_data["load"] or result.raw_data["skip_test"]:
+            valid_data["action_url"] = (
+                f"https://github.com/{plugin_config.github_repository}/actions/runs/{plugin_config.github_run_id}"
+            )
+    # 如果 tags 字段为空则不显示
+    if not valid_data.get("tags"):
+        valid_data.pop("tags", None)
+
     # 仅显示必要字段
     display_keys = [
         "homepage",
-        "tags",
         "project_link",
+        "tags",
         "type",
         "supported_adapters",
-        "time",
+        "action_url",
         "version",
+        "time",
     ]
 
     # 按照 display_keys 顺序展示数据
-    data = {
-        key: result.valid_data[key] for key in display_keys if key in result.valid_data
-    }
-
-    if not data.get("tags"):
-        data.pop("tags", None)
-
-    if result.type == PublishType.PLUGIN:
-        # https://github.com/he0119/action-test/actions/runs/4469672520
-        # 仅在测试通过或跳过测试时显示
-        # 如果 load 为 False 的时候 valid_data 里面没有 load 字段，所以直接用 raw_data
-        if result.raw_data["load"] or result.raw_data["skip_test"]:
-            data["action_url"] = (
-                f"https://github.com/{plugin_config.github_repository}/actions/runs/{plugin_config.github_run_id}"
-            )
+    data = {key: valid_data[key] for key in display_keys if key in valid_data}
 
     template = env.get_template("comment.md.jinja")
     return await template.render_async(

diff --git a/src/plugins/github/plugins/publish/templates/render_data.md.jinja b/src/plugins/github/plugins/publish/templates/render_data.md.jinja
@@ -16,7 +16,7 @@
 插件 <a href="{{ value }}">加载测试</a> 通过。
 {%- endif %}
 {%- elif key == "time" %}
-插件发布时间：{{ value|format_time }}。
+发布时间：{{ value|format_time }}。
 {%- else %}
 {{ key|key_to_name }}: {{ value }}。
 {%- endif %}

diff --git a/tests/plugins/github/config/process/test_config_check.py b/tests/plugins/github/config/process/test_config_check.py
@@ -148,7 +148,7 @@ async def test_process_config_check(
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 项目 <a href="https://pypi.org/project/nonebot-plugin-treehelp/">nonebot-plugin-treehelp</a> 已发布至 PyPI。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: nonebot.adapters.onebot.v11。</li><li>✅ 插件发布时间：2024-07-13 12:41:40 CST。</li><li>✅ 插件版本号: 1.0.0。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/nonebot-plugin-treehelp/">nonebot-plugin-treehelp</a> 已发布至 PyPI。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: nonebot.adapters.onebot.v11。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li><li>✅ 版本号: 1.0.0。</li><li>✅ 发布时间：2024-07-13 12:41:40 CST。</li></code></pre>
 </details>
 
 ---

diff --git a/tests/plugins/github/publish/process/test_publish_check.py b/tests/plugins/github/publish/process/test_publish_check.py
@@ -281,7 +281,7 @@ async def test_adapter_process_publish_check(
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 插件发布时间：2023-09-01 08:00:00 CST。</li><li>✅ 插件版本号: 0.0.1。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 版本号: 0.0.1。</li><li>✅ 发布时间：2023-09-01 08:00:00 CST。</li></code></pre>
 </details>
 
 ---
@@ -568,7 +568,7 @@ async def test_plugin_process_publish_check(
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: 所有。</li><li>✅ 插件发布时间：2023-09-01 08:00:00 CST。</li><li>✅ 插件版本号: 1.0.0。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: 所有。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li><li>✅ 版本号: 1.0.0。</li><li>✅ 发布时间：2023-09-01 08:00:00 CST。</li></code></pre>
 </details>
 
 ---
@@ -857,7 +857,7 @@ async def test_plugin_process_publish_check_re_run(
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: 所有。</li><li>✅ 插件发布时间：2023-09-01 08:00:00 CST。</li><li>✅ 插件版本号: 1.0.0。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://nonebot.dev">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: 所有。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li><li>✅ 版本号: 1.0.0。</li><li>✅ 发布时间：2023-09-01 08:00:00 CST。</li></code></pre>
 </details>
 
 ---
@@ -1754,7 +1754,7 @@ async def test_skip_plugin_check(
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 标签: test-#ffffff。</li><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 插件发布时间：2023-09-01 08:00:00 CST。</li><li>✅ 插件版本号: 0.0.1。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 已跳过。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://pypi.org/project/project_link/">project_link</a> 已发布至 PyPI。</li><li>✅ 标签: test-#ffffff。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 已跳过。</li><li>✅ 版本号: 0.0.1。</li><li>✅ 发布时间：2023-09-01 08:00:00 CST。</li></code></pre>
 </details>
 
 ---

diff --git a/tests/plugins/github/publish/render/test_publish_render_data.py b/tests/plugins/github/publish/render/test_publish_render_data.py
@@ -113,6 +113,8 @@ async def test_render_data_adapter(app: App):
         "homepage": "https://github.com/CMHopeSunshine/nonebot-adapter-villa",
         "tags": [{"label": "米哈游", "color": "#e10909"}],
         "is_official": False,
+        "time": "2023-12-21T06:57:44.318894Z",
+        "version": "1.4.2",
     }
     result = ValidationDict(
         type=PublishType.ADAPTER,
@@ -134,7 +136,7 @@ async def test_render_data_adapter(app: App):
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 项目 <a href="https://github.com/CMHopeSunshine/nonebot-adapter-villa">主页</a> 返回状态码 200。</li><li>✅ 标签: 米哈游-#e10909。</li><li>✅ 项目 <a href="https://pypi.org/project/nonebot-adapter-villa/">nonebot-adapter-villa</a> 已发布至 PyPI。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://github.com/CMHopeSunshine/nonebot-adapter-villa">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/nonebot-adapter-villa/">nonebot-adapter-villa</a> 已发布至 PyPI。</li><li>✅ 标签: 米哈游-#e10909。</li><li>✅ 版本号: 1.4.2。</li><li>✅ 发布时间：2023-12-21 14:57:44 CST。</li></code></pre>
 </details>
 
 ---
@@ -162,7 +164,7 @@ async def test_render_data_plugin(app: App, mocker: MockFixture):
         "author": "he0119",
         "author_id": 1,
         "homepage": "https://github.com/he0119/nonebot-plugin-treehelp",
-        "tags": [],
+        "tags": [{"label": "render", "color": "#ffffff"}],
         "is_official": False,
         "type": "application",
         "supported_adapters": None,
@@ -191,7 +193,7 @@ async def test_render_data_plugin(app: App, mocker: MockFixture):
 
 <details>
 <summary>详情</summary>
-<pre><code><li>✅ 项目 <a href="https://github.com/he0119/nonebot-plugin-treehelp">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/nonebot-plugin-treehelp/">nonebot-plugin-treehelp</a> 已发布至 PyPI。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: 所有。</li><li>✅ 插件发布时间：2024-07-13 12:41:40 CST。</li><li>✅ 插件版本号: 0.5.0。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li></code></pre>
+<pre><code><li>✅ 项目 <a href="https://github.com/he0119/nonebot-plugin-treehelp">主页</a> 返回状态码 200。</li><li>✅ 项目 <a href="https://pypi.org/project/nonebot-plugin-treehelp/">nonebot-plugin-treehelp</a> 已发布至 PyPI。</li><li>✅ 标签: render-#ffffff。</li><li>✅ 插件类型: application。</li><li>✅ 插件支持的适配器: 所有。</li><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li><li>✅ 版本号: 0.5.0。</li><li>✅ 发布时间：2024-07-13 12:41:40 CST。</li></code></pre>
 </details>
 
 ---