Skip to content

Commit b69d9ad

Browse files
committed
docs: update README and comments on files.list
Signed-off-by: Camber Huang <camber@poi.science>
1 parent 75eeee6 commit b69d9ad

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,50 @@
11
# misc-files
2-
Repository for miscellaneous files frequently overwritten by upstreams
32

43
[![Periodic updates](https://github.com/AOSC-Dev/misc-files/actions/workflows/periodic-update.yml/badge.svg)](https://github.com/AOSC-Dev/misc-files/actions/workflows/periodic-update.yml)
4+
5+
Repository for miscellaneous files frequently overwritten by upstreams.
6+
7+
This repository is driven by the tracking list file `files.list` and utilizes GitHub Actions to keep files updated. Files in this repository are being used by the following packages:
8+
9+
- `iana-etc`:
10+
- `bind`
11+
12+
## `files.list`
13+
14+
This file tells what file should be tracked by which package and renamed in the following format:
15+
16+
```
17+
package-name url [file-name]
18+
```
19+
20+
Example:
21+
22+
```
23+
bind https://www.internic.net/zones/named.root
24+
```
25+
26+
* package-name: The name of the package to which the file belongs
27+
* url: The URL to download the file from
28+
* file-name: Optional, will default to `$(basename $url)` if not provided
29+
30+
## How the workflow works?
31+
32+
The main workflow `periodic-update` is triggered under the following conditions:
33+
34+
- Update `files.list` on branch `master`
35+
- Cron `"0 0 * * *"`
36+
- Manually triggered by maintainers
37+
38+
When triggered, the workflow:
39+
40+
1. Parses `files.list` to determine which files to download.
41+
2. Downloads and optionally renames each file, and calculates their checksums.
42+
3. If changes are detected:
43+
- Commits the updates directly to the `master` branch
44+
- Then syncs the updated files to their package-specific branch (e.g. `iana-etc`)
45+
- Tags the commit in that branch with the current date (e.g. `iana-etc-20250914`)
46+
4. If no changes are detected, the commit step is skipped and the workflow exits without further action.
47+
48+
## License
49+
50+
The workflow itself is licensed under the MIT License. All other files originated from external sources are subject to their respective upstream license.

files.list

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# package-name url [file-name]
2+
# bind https://www.internic.net/zones/named.root
3+
# iana-etc https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml service-names-port-numbers.iana
14
bind https://www.internic.net/zones/named.root
25

36
iana-etc https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml

0 commit comments

Comments
 (0)