Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.22 KB

README.md

File metadata and controls

40 lines (32 loc) · 1.22 KB

scripts/

This is where any scripts you wish to include in your orb can be kept. This is encouraged to ensure your orb can have all aspects tested, and is easier to author, since we sacrifice most features an editor offers when editing scripts as text in YAML.

As a part of keeping things seperate, it is encouraged to use environment variables to pass through parameters, rather than using the << parameter. >> syntax that CircleCI offers.

Including Scripts

Utilizing the circleci orb pack CLI command, it is possible to import files (such as shell scripts), using the <<include(scripts/script_name.sh)>> syntax in place of any config key's value.

# commands/greet.yml
description: >
  This command echos "Hello World" using file inclusion.
parameters:
  to:
    type: string
    default: "World"
    description: "Hello to who?"
steps:
  - run:
      environment:
        PARAM_TO: <<parameters.to>
      name: Hello <<parameters.to>
      command: <<include(scripts/greet.sh)>>

# scripts/greet.sh
Greet() {
    echo Hello ${PARAM_TO}
}

# Will not run if sourced from another script. This is done so this script may be tested.
# View src/tests for more information.
if [[ "$_" == "$0" ]]; then
    Greet
fi