vieter/docs/content/usage/builds/_index.md

52 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2022-06-09 10:25:36 +02:00
---
weight: 20
---
# Building packages
The automatic build system is what makes Vieter very useful as a replacement
for an AUR helper. It can perodically build packages & publish them to your
personal Vieter repository server, removing the need to build the packages
locally.
## Adding builds
Before the cron system can start building your package, you need to add its
info to the system. The Vieter repository server exposes an HTTP API for this
(see the [HTTP API Docs](https://rustybever.be/docs/vieter/api/) for more
info). For ease of use, the Vieter binary contains a CLI interface for
interacting with this API (see [Configuration](/configuration) for
configuration details). The [man
2022-06-16 17:38:41 +02:00
pages](https://rustybever.be/man/vieter/vieter-targets.1.html) describe this in
2022-06-09 10:25:36 +02:00
greater detail, but the basic usage is as follows:
```
2022-06-17 14:52:59 +02:00
vieter targets add some-url some-repository
2022-06-09 10:25:36 +02:00
```
Here, `some-url` is the URL of the Git repository containing the PKGBUILD. This
2022-06-09 16:26:53 +02:00
URL is passed to `git clone`, meaning the repository should be public. Vieter
2022-06-09 10:25:36 +02:00
expects the same format as an AUR Git repository, so you can directly use AUR
2022-06-17 14:52:59 +02:00
URLs here. Alternatively, you can also provide the URL to a PKGBUILD file
instead. See
[vieter-targets-add(1)](https://rustybever.be/man/vieter/vieter-targets-add.1.html)
for more information.
2022-06-09 10:25:36 +02:00
2022-06-17 14:52:59 +02:00
`some-repo` is the repository to which the built package archives should be
published.
2022-06-09 10:25:36 +02:00
The above command intentionally leaves out a few parameters to make the CLI
more useable. For information on how to modify all parameters using the CLI,
see
2022-06-17 14:52:59 +02:00
[vieter-targets(1)](https://rustybever.be/man/vieter/vieter-targets.1.html).
## Reading logs
The logs of each build are uploaded to the Vieter repository server, along with
information about the exit code of the build container, when the build
started/ended etc. These logs can then be accessed using the [HTTP
API](https://rustybever.be/docs/vieter/api/).
For ease of use, the logs are also available using some CLI commands; see
[vieter-logs(1)](https://rustybever.be/man/vieter/vieter-logs.1.html) for more
information.