0.Prerequisite
Last updated
Last updated
We start by learning:
Linter|Validator is the CLI/Library
that lints & validates a .SBUILD
Script.
Runner|Interpreter is the CLI/Library
that runs the .SBUILD.validated
Script.
SBUILDER is the CLI/Library
that merges the Linter & the Runner into one, and is what soar build
uses under the hood.
This is sometimes also referred as Builder/Runner/Interpreter. Don't get too hung up on the names. As a human, you will likely only ever have to interact with the Linter|Validator ,rest is all taken care of Automatically by Soar.
ENFORCED
means the field is NOT Skippable & MUST Exist
NON_ENFORCED
means the field is Skippable & NOT Mandatory
RECOMMENDED
means, it can be skipped, but best to try to include it if possible
NOT-RECOMMENDED
means, you shouldn't use it as there's a better way, but if you want, you can
$SBUILD_OUTDIR
is a temporary directory the Interpreter
uses to run the .SBUILD
Script in. Also referred as $TMPDIR
Sometimes.
$SBUILD_TMPDIR
is a dir inside $SBUILD_OUTDIR
(PATH: $SBUILD_OUTDIR/SBUILD_TEMP
) that can be used to store NON-NEEDED Files
x_exec.pkgver
refers to the raw/vanilla shell cmds that are run to get the Version of the Package
x_exec.run
refers to the raw/vanilla shell cmds that are run to download, build & fetch the Package
It is always RECOMMENDED to check your .SBUILD
with yamllint & the with shellcheck
For more Detailed Guide, Follow the Instructions: https://docs.pkgforge.dev/sbuild/instructions