Skip to content

Commit aa37ea8

Browse files
MingcongBaiMingcongBai
committed
packaging: add TUM
1 parent c5ad2a6 commit aa37ea8

File tree

2 files changed

+203
-0
lines changed

2 files changed

+203
-0
lines changed

‎content/developer/packaging/topic-update-manifest.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
+++
2+
title = "Topic Update Manifest"
3+
description = "Metadata for AOSC OS Updates"
4+
+++
5+
6+
Overview
7+
===
8+
9+
The topic update manifest aims to provide a user-readable overview of changes
10+
during system updates. The files are stored in the TOML format in the
11+
[ABBS tree](https://github.com/AOSC-Dev/aosc-os-abbs) and converted into the
12+
JSON format on the server-side.
13+
14+
Examples
15+
===
16+
17+
Below is an example for a conventional topic update manifest file:
18+
19+
```
20+
name.default = "KDE Updates (Winter 2023)"
21+
name.zh_CN = "KDE 更新（2023 年冬季）"
22+
# Security update (true/false)?
23+
security = true
24+
# OPTIONAL: PSA message for users.
25+
caution.default = """
26+
This topic may use significantly more memory after reboot. Our testing finds
27+
that the new KDE version may use up to 16GiB of RAM.
28+
"""
29+
caution.zh_CN = """
30+
本次更新重启后可能会需要更多内存。据我社维护者测试，新版 KDE 可能需要接近 16GiB 内存。"""
31+
32+
[packages]
33+
konsole = "23.04.1-1"
34+
dolphin = "23.04.1"
35+
# Package removed as part of the topic.
36+
pykde = false
37+
```
38+
39+
Below is a "cumulative" topic update manifest file:
40+
41+
```toml
42+
name.default = "Winter 2023 Cumulative Update for amd64 AOSC OS systems"
43+
name.zh_MS = "适用于 amd64 AOSC OS 版本的 23 冬季累计更新"
44+
45+
# Must not exist alongside [packages].
46+
topics = [
47+
"kde-survey-20231201",
48+
"core-12.1.0"
49+
]
50+
```
51+
52+
Files
53+
===
54+
55+
Topic update manifest files will be stored in a special `topics/` folder in the
56+
ABBS tree:
57+
58+
```
59+
TREE/topics/kde-survey-20231201.toml
60+
TREE/topics/llvm-16.0.6.toml
61+
TREE/topics/*.toml
62+
```
63+
64+
The repository server will pull the manifests from the ABBS tree, processing
65+
the them into a single JSON:
66+
67+
```
68+
*.toml => (server pulls the manifests) => /mirror/debs/manifest/updates.json
69+
```
70+
71+
A sample post-processed JSON file should look like this:
72+
73+
```json
74+
{
75+
"kde-survey-20231201": {
76+
"type": "conventional",
77+
"name": [
78+
{ "default": "KDE Updates (Winter 2023)" },
79+
{ "zh_CN": "KDE 更新（2023 年冬季）" }
80+
],
81+
"security": true,
82+
"caution": [
83+
{ "default": "This topic may use significantly more memory after reboot. Our testing finds\nthat the new KDE version may use up to 16GiB of RAM." },
84+
{ "zh_CN": "本次更新重启后可能会需要更多内存。据我社维护者测试，新版 KDE 可能需要接近 16GiB 内存。" }
85+
],
86+
"packages": [
87+
{ "name": "konsole", "version": "23.04.1-1" },
88+
{ "name": "dolphin", "version": "23.04.1" },
89+
{ "name": "pykde", "version": null }
90+
]
91+
},
92+
"cumulative-2023H3": {
93+
"type": "cumulative",
94+
"name": [
95+
{ "default": "Winter 2023 Cumulative Update for amd64 AOSC OS systems" },
96+
{ "zh_MS": "适用于 amd64 AOSC OS 版本的 23 冬季累计更新" }
97+
],
98+
"topics": [
99+
"kde-survey-20231201",
100+
"core-12.1.0"
101+
]
102+
}
103+
}
104+
```

‎content/developer/packaging/topic-update-manifest.zh.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
+++
2+
title = "更新主题元数据"
3+
description = "安同 OS 更新元数据规范"
4+
+++
5+
6+
概述
7+
===
8+
9+
本规范旨在为用户提供一个友好、可读性高的系统更新概要。元数据文件使用 TOML 格式存放于 [ABBS 树](https://github.com/AOSC-Dev/aosc-os-abbs)中，而后转换为 JSON 格式于服务端存放。
10+
11+
示例
12+
===
13+
14+
更新主题元数据文件范例如下：
15+
16+
```
17+
name.default = "KDE Updates (Winter 2023)"
18+
name.zh_CN = "KDE 更新（2023 年冬季）"
19+
# Security update (true/false)?
20+
security = true
21+
# OPTIONAL: PSA message for users.
22+
caution.default = """
23+
This topic may use significantly more memory after reboot. Our testing finds
24+
that the new KDE version may use up to 16GiB of RAM.
25+
"""
26+
caution.zh_CN = """
27+
本次更新重启后可能会需要更多内存。据我社维护者测试，新版 KDE 可能需要接近 16GiB 内存。"""
28+
29+
[packages]
30+
konsole = "23.04.1-1"
31+
dolphin = "23.04.1"
32+
# Package removed as part of the topic.
33+
pykde = false
34+
```
35+
36+
亦可按需编写“累积更新”元数据，如下：
37+
38+
```toml
39+
name.default = "Winter 2023 Cumulative Update for amd64 AOSC OS systems"
40+
name.zh_MS = "适用于 amd64 AOSC OS 版本的 23 冬季累计更新"
41+
42+
# Must not exist alongside [packages].
43+
topics = [
44+
"kde-survey-20231201",
45+
"core-12.1.0"
46+
]
47+
```
48+
49+
文件存放
50+
===
51+
52+
元数据文件存放在 ABBS 树中的 `topics/` 路径下：
53+
54+
```
55+
TREE/topics/kde-survey-20231201.toml
56+
TREE/topics/llvm-16.0.6.toml
57+
TREE/topics/*.toml
58+
```
59+
60+
软件源服务器定期拉取元数据，并将其处理为单个 JSON 文件：
61+
62+
```
63+
*.toml =>（服务端拉取）=> /mirror/debs/manifest/updates.json
64+
```
65+
66+
经处理的 JSON 文件样例如下：
67+
68+
```json
69+
{
70+
"kde-survey-20231201": {
71+
"type": "conventional",
72+
"name": [
73+
{ "default": "KDE Updates (Winter 2023)" },
74+
{ "zh_CN": "KDE 更新（2023 年冬季）" }
75+
],
76+
"security": true,
77+
"caution": [
78+
{ "default": "This topic may use significantly more memory after reboot. Our testing finds\nthat the new KDE version may use up to 16GiB of RAM." },
79+
{ "zh_CN": "本次更新重启后可能会需要更多内存。据我社维护者测试，新版 KDE 可能需要接近 16GiB 内存。" }
80+
],
81+
"packages": [
82+
{ "name": "konsole", "version": "23.04.1-1" },
83+
{ "name": "dolphin", "version": "23.04.1" },
84+
{ "name": "pykde", "version": null }
85+
]
86+
},
87+
"cumulative-2023H3": {
88+
"type": "cumulative",
89+
"name": [
90+
{ "default": "Winter 2023 Cumulative Update for amd64 AOSC OS systems" },
91+
{ "zh_MS": "适用于 amd64 AOSC OS 版本的 23 冬季累计更新" }
92+
],
93+
"topics": [
94+
"kde-survey-20231201",
95+
"core-12.1.0"
96+
]
97+
}
98+
}
99+
```

0 commit comments

Comments
 (0)