| blob | 7f613a54c263575bb2d43480920ffea71eb5ea78 |
1 # Workflow Build Packages (codename Project Cake)\r
2 \r
3 ## Syntax\r
4 \r
5 ```\r
6 /build <Package> [<Package> ...]\r
7 ```\r
8 ```\r
9 /build\r
10 ```\r
11 \r
12 ## Description\r
13 \r
14 The `/build` command builds packages via GitHub Actions. It starts clean, up-to-date instances of buildkit container, runs `acbs-build` to build packages.\r
15 \r
16 When replying the command under an issue, packages are built from `stable` branch. When replying the command under a pull request, packages are built from the source branch of the pull request.\r
17 \r
18 If packages are specified, only these packages will be built. If no packages are specified and the command is replied under a pull request, all packages which have spec file changed will be built.\r
19 \r
20 If you would like for the workflow to run as a status check, prefix your pull request title with [ci].\r
21 \r
22 It's also possible to run this workflow manually[^1] or using the REST API[^2].\r
23 \r
24 ## Examples\r
25 \r
26 ### Example 1: Building One Package\r
27 \r
28 ```\r
29 /build aosc-aaa\r
30 ```\r
31 \r
32 ### Example 2: Building Multiple Packages\r
33 \r
34 ```\r
35 /build openssl openssl+32\r
36 ```\r
37 \r
38 ### Example 3: Building A Group Of Packages\r
39 \r
40 ```\r
41 /build groups/dotnet\r
42 ```\r
43 \r
44 ### Example 4: Building All Changed Packages In A Pull Request\r
45 \r
46 ```\r
47 /build\r
48 ```\r
49 \r
50 ## Notes\r
51 \r
52 - Currently, this command only supports GitHub-hosted runners.\r
53 - Microsoft Azure's Standard_DS2_v2 virtual machines only support x86-64 (`amd64`) architecture and may not have sufficient performance or storage to build some packages.\r
54 - GitHub-hosted runners currently provide no TTY device[^3], any build that relies on this will fail.\r
55 - Up to 256 packages could be built at a time.\r
56 \r
57 ## Further Reading\r
58 \r
59 - [ACBS](https://wiki.aosc.io/developer/packaging/acbs/)\r
60 \r
61 ## Explanation on the codename\r
62 \r
63 The cake is a lie[^4]! Though Project Cake is an effort to augment AOSC OS's ongoing maintenance automation project[^5], it will only work in simple scenarios.\r
64 \r
65 [^1]: https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow\r
66 [^2]: https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event\r
67 [^3]: https://github.com/actions/runner/issues/241#issuecomment-556845290\r
68 [^4]: https://en.wikipedia.org/wiki/The_cake_is_a_lie\r
69 [^5]: https://wiki.aosc.io/developer/automation/\r