script@v2

The script module can be used to run arbitrary posix shell snippets and scripts at image build time. This is intended for running commands that need no YAML configuration.

The snippets, which are run in a /bin/sh subshell, are declared under snippets:.
The scripts, which are run from the files/scripts/ directory, are declared under scripts:.

Creating a Script

Look at example.sh for an example shell script. You can rename and copy the file for your own purposes. In order for the script to be executed, declare it in the recipe

When creating a bash script, please make sure

• …its filename ends with .sh.
  • This follows convention for shell scripts.
• …it starts with a shebang like #!/usr/bin/env bash.
  • This ensures the script is ran with the correct interpreter / shell.
• …it contains the command set -euo pipefail right after the shebang.
  • This will make the image build fail if your script fails. If you do not care if your script works or not, you can omit this line.

When creating a posix shell script, please make sure

• …its filename ends with .sh.
  • This follows convention for shell scripts.
• …it starts with a shebang like #!/bin/sh.
  • This ensures the script is ran with the correct interpreter / shell.
• …it contains the command set -eu right after the shebang.
  • This will make the image build fail if your script fails. If you do not care if your script works or not, you can omit this line.

When creating a Nushell script, please make sure

• …its filename ends with .nu.
  • This follows convention for Nushell scripts.
• …it starts with a shebang like #!/usr/bin/env nu.

Example configuration

type: script
snippets:
  - "curl https://example.com/examplebinary > /usr/bin/examplebinary" # example: download binary
  - "ln -sf /usr/bin/ld.bfd /etc/alternatives/ld && ln -sf /etc/alternatives/ld /usr/bin/ld" # example: ld alternatives symlink workaround
scripts:
  - myscript.sh # example: run files/scripts/myscript.sh
  - myscript.nu # example: run files/scripts/myscript.nu

Configuration options

snippets: (optional array)

List of bash one-liners to run.

scripts: (optional array)

List of script files to run.