trdl.yaml / Reference

The trdl.yaml configuration contains instructions that define the environment and command set needed to build release artifacts.

On release, trdl reads trdl.yaml from the Git tag and performs the build:

Runs a container based on the selected Docker image.
Mounts the source code of the Git tag into the /git directory.
Executes build instructions in the /git directory.
Saves release artifacts from the /result directory.

0	dockerImage: string !	# Docker image name. Repository and digest are mandatory `REPO[:TAG]@DIGEST` (e.g. `ubuntu:18.04@sha256:538529c9d229fb55f50e6746b119e899775205d62c0fc1b7e679b30d02ecb6e8`)
1	commands: [ string, ... ] !	# Build instructions. The instructions can use the `{{ .Tag }}` pattern, which is replaced by a git tag

Release artifacts layout

After completing the build instructions, the release artifacts must reside in the /result directory. Artifacts require a strict directory organization to integrate with the trdl client, deliver to different platforms, and efficiently handle executable files.

Each release artifact must be saved to the directory of the platform for which it is designed. The name of the platform directory depends on the operating system and the <os>-<arch> parameter (system architecture). The reserved name any can be used if there is no need to segregate artifacts based on OS and/or system architecture. Below is a list of supported combinations, arranged according to the trdl client preferences.

darwin-amd64
darwin-arm64
darwin-any
linux-amd64
linux-amd64
linux-any
windows-amd64
windows-any
any-any

To use the basic functions of the trdl client (e.g., the trdl use command), you need to save the executables in the bin subdirectory.

As a result, for most projects, the /result directory after the build should have the following structure:

result
├── ...
└── <os>-<arch>
    ├── bin
    │   ├── ...
    │   └── <release artifact>
    ├── ...
    └── <release artifact>

Here:

os — operating system (darwin, linux, windows, or any if the release artifacts are system-independent);
arch — architecture (amd64, arm64, or any if the release artifacts are platform-independent);
release artifact — an arbitrary file.

Example

trdl.yaml

dockerImage: alpine:3.13.6@sha256:e15947432b813e8ffa90165da919953e2ce850bef511a0ad1287d7cb86de84b5
commands:
- ./build.sh {{ .Tag }} && cp -a release-build/{{ .Tag }}/* /result

build.sh

#!/bin/sh -e
VERSION=$1
if [ -z "$VERSION" ] ; then
    echo "Required version argument!" 1>&2
    echo 1>&2
    echo "Usage: $0 VERSION" 1>&2
    exit 1
fi
mkdir -p release-build/${VERSION}/any-any/bin
printf "echo ${VERSION}\n" > release-build/${VERSION}/any-any/bin/trdl-example.sh
mkdir -p release-build/${VERSION}/windows-any/bin
printf "@echo off\necho ${VERSION}\n" > release-build/${VERSION}/windows-any/bin/trdl-example.ps1

Below is the structure of the /result directory after running assembly instructions

result
├── any-any
│   └── bin
│       └── trdl-example.sh
└── windows-any
    └── bin
        └── trdl-example.ps1