More build command info

This commit is contained in:
Sarah Jamie Lewis 2023-01-18 11:49:33 -08:00
parent a72b9a47e9
commit 593a9b6d52
1 changed files with 3 additions and 3 deletions

View File

@ -22,15 +22,15 @@ A build script sets up dependencies, folder locations, and source code repositor
Basic example: `repliqate cloud-img.qcow2 build.script`
## Build Script
## Writing a Build Script
By default, each line is interpreted as a command to run in the build environment.
By default, each line is interpreted as a shell command to run in the build environment e.g. `echo "Hello World` will result in `echo "Hello World"` being run in the VM.
Lines starting with `#` are treated as comments and ignored.
Lines starting with `@%` e.g. `@%echo "Hello World"` indicate to repliqate that it should output the result of the command. This is useful when debugging build steps.
Lines starting with `@!` are treated as repliqate meta commands:
Lines starting with `@!` are treated as repliqate meta commands, these commands extend the execution environment with functionality useful for constructing and checking reproducible builds:
* `@!check <filename> <sha512hash to check>` - executes a `sha512sum` command on the given file, checks the result against the given hash, and terminates the build on failure.
* `@!preserve` - repliqate will skip deleting temporary disk images at shutdown (see FAQ for more information)