Automation scripts, libraries for re-use in other repositories

Dependencies

The install script and common subdirectory components require the following system packages (or their equivalents):

• bash
• core-utils
• git
• install

Installation

During build of an environment (VM, container image, etc), execute any version of the install script, preferably as root. The script must be passed the version number of the project release to install. Before making changes to the environment, the script will first download and then re-execute the requested version of itself.

For example, to install the v1.0.0 release, run:

url='https://github.com/containers/automation/releases/latest/download/install_automation.sh'
curl -sL "$url" | bash -s 1.1.3

Alt. Installation

If a clone of the repository is already available locally, the installer can be invoked with the magic version number '0.0.0'. Note that, while it will install the files from the local clone as-is, the installer still needs to reach out to github to retrieve tree-history details. This is required for the installer to properly set the actual version-number as part of the process.

Though not recommended at all, it is also possible to specify the version as latest. This will clone down whatever happens to be on the master branch at the time. Though it will probably work, it's best for stability to specify an explicit released version.

Usage

The basic install consists of copying the contents of the common (subdirectory) and the installer script into a central location on the system. Because this location can vary, a global shell variable $AUTOMATION_LIB_PATH is widely used. Therefore, it is highly recommended that all users and calling scripts explicitly load env. var. definitions set in the file /etc/automation_environment.

Subdirectories

.github/workflows

Directory containing workflows for Github Actions.

bin

Ths directory contains scripts intended for execution under multiple environments, pertaining to operations on this whole repository. For example, executing all unit tests, installing components, etc.

common

This directory contains general-purpose scripts, libraries, and their unit-tests. They're intended to be used individually or as a whole from within automation of other repositories.

cirrus-ci_retrospective

See the README.md file in the subdirectory for more information