example.sh

#!/usr/bin/env bash

# NAME
#     example.sh - Provide an example custom ORCA script.
#
# SYNOPSIS
#     example.sh
#
# DESCRIPTION
#     Provides an example of customizing an ORCA build by adding or
#     modifying jobs. See real working examples:
#
#     - https://github.com/acquia/coding-standards-php/blob/v1.0.1/.github/workflows/orca.yml#L77 and
#       https://github.com/acquia/coding-standards-php/tree/v0.5.0/bin/travis
#
#     - https://github.com/acquia/drupal-spec-tool/blob/v6.0.0-alpha1/.github/workflows/orca.yml#L91 and
#       https://github.com/acquia/drupal-spec-tool/tree/4.0.1/bin/travis
#
#     - https://github.com/acquia/orca/blob/v3.27.0/.github/workflows/orca.yml#L125 and
#       https://github.com/acquia/orca/tree/v3.12.2/bin/ci/self-test
#
#     Remember to make your script executable! E.g.:
#     chmod u+x bin/ci/example.sh

# Make bash resolve paths from the location of this script, not the CWD (current
# working directory) of the user or process that called it.
cd "$(dirname "$0")" || exit 1

# Reuse ORCA's own includes for its $PATH additions and environment variables.
source ../../../orca/bin/ci/_includes.sh || exit 1

# ORCA provides numerous general purpose environment variables you can use.
echo "The SUT is cloned at $CI_WORKSPACE"

# ORCA provides additional special purpose environment variables. Use the below
# command to see the list with current values. Its output is included in the
# before_install phase of all CI jobs for debugging purposes.
orca debug:env-vars

# Unconditioned statements will be executed on every job.
echo "The current job is $ORCA_JOB."

# Target an out-of-the-box ORCA job to modify its behavior.
if [[ "$ORCA_JOB" == "ISOLATED_TEST_ON_CURRENT" ]]; then
  # For example, add test dependencies before running automated tests.
  if [[ -d "$ORCA_FIXTURE_DIR" ]]; then
    (
      cd "$ORCA_FIXTURE_DIR" || exit
      composer require drupal/example
    )
  fi
fi

# Rather than targeting an out-of-the-box ORCA job, run a completely custom job.
# ORCA will not run unless ORCA_JOB is set.
if [[ ! "$ORCA_JOB" ]]; then
  # Do something totally custom as your own job.
  composer install
fi

# Target any condition of your own making, e.g., an environment variable set in
# your CI script.
if [[ "$MY_CONDITION" == "TRUE" ]]; then
  echo "\$MY_CONDITION attained"
fi