Skip to content

Commit aa3f7d9

Browse files
committed
docs: update README and comments on files.list
Signed-off-by: Camber Huang <[email protected]>
1 parent 75eeee6 commit aa3f7d9

File tree

2 files changed

+42
-1
lines changed

2 files changed

+42
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,42 @@
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.
8+
9+
## CI/CD
10+
11+
The main workflow `periodic-update` is triggered under the following conditions:
12+
13+
- Update `files.list` on branch `master`
14+
- Cron `"0 0 * * *"`
15+
- Manually triggered by maintainers
16+
17+
As of update this repository is tracking and being referenced by the following packages:
18+
19+
- `iana-etc`
20+
- `bind`
21+
22+
## `files.list`
23+
24+
This file tells what file should be tracked by which package and rename to what name with the format like below:
25+
26+
```
27+
package-name url [file-name]
28+
```
29+
30+
Example:
31+
32+
```
33+
bind https://www.internic.net/zones/named.root
34+
```
35+
36+
* package-name: The name of the package to which the file belongs
37+
* url: The URL to download the file from
38+
* file-name: Optional, will default to `$(basename $url)` if not provided
39+
40+
## How the CI Works
41+
42+
TBF

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)