Bootstrap plugin¶

Description¶

The bootstrap is used for executing bootstrap files. This is often used in build chains.

Mandatory settings¶

There are no mandatory settings for the bootstrap plugin.

Optional settings¶

The configuration of the bootstrap plugin may contain the following settings:

patterns: A list of patterns to apply on the command line. See Patterns (5).

enviroment: A list of environment variables that should be set before the commands are executed. See Environment (5).

command-line: Additional command line parameters to pass as a list of separate arguments. By default no additional arguments are added.

working-dir: The working directory of the command. Can be an absolute path are a relative one w.r.t. the path to the considered configuration file. Commands that should be executed relative to the current working dir can use the {EH_WORKING_DIR} pattern.

filename: The name of the bootstrap script. Default: bootstrap.sh.

Example¶

Configuration¶

commands:                       # Define the commands that can be run
    example: run the bootstrap example

patterns:                       # Define the patterns that can be used
    EXAMPLE_PATTERN:            # Define the EXAMPLE_PATTERN.
        default-values:         # Only define the default value
            - world!

example:
    - bootstrap                 # Use the command-line-command plugin when running the 'example' command

bootstrap:                      # Bootstrap configuration settings
    example:                    # Settings specific to the 'example' command
        patterns:               # Define the patterns that are used
            - EXAMPLE_PATTERN
        filename: src/bootstrap-mock.sh     # Set the name of the bootstrap script
        command-line:           # Define 2 additional command line flags
            - "hello"
            - "{EXAMPLE_PATTERN}"

Usage¶

Save the example to an exec-helper configuration file and execute in the same directory:

eh example