art-build-scripts

Contents:

• Overview
• Requirements
• Directory Structure
• Guidelines

Overview

The art-build-scripts are part of a stable/tip checkout. All scripts work for both Tip and Stable. The scripts follow the Google Shell Style Guide, plus following additions:

• All scripts use set -o nounset (done by default in utils.sh).
• Constant variables used in the same script are in lower_case.
• Constant variables used across scripts or picked up from environment are in UPPER_CASE.

Requirements

1. bash 4.2+

Note: you don't need to have shellcheck installed, presubmit.sh will download it if necessary.

Guidelines

• All executable scripts should have a main() function.
• All executable scripts should take options (at least -h and -v) in arguments_parser().
• All executable scripts have a usage() (-h or --help) that tells how the script should be used.
• All helper scripts are not executable.
• All scripts should include at least utils.sh, which
  • sets global shell options like set -o nounset and,
  • enables coloured logging for interactive sessions (not jenkins).
• All scripts and changes should be checked by running ./presubmit.sh.