Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.36 KB

github-actions.md

File metadata and controls

64 lines (45 loc) · 2.36 KB
Raw

Github Actions

There are many ways to install CommandBox in your Github actions. However, we have created the official Github Action package so you can install CommandBox easily: Setup CommandBox Action

{% embed url="https://github.com/Ortus-Solutions/setup-commandbox" %} Setup CommandBox Action {% endembed %}

{% embed url="https://github.com/marketplace/actions/setup-commandbox-cli" %} Githb Action Marketplace {% endembed %}

Inputs

The following are all the different input variables you can use on the action so you can setup CommandBox with ForgeBox API keys, default packages, specific versions and much more.

InputTypeDefaultDescription
forgeboxAPIKeystring---If added to the action, we will seed it in CommandBox for you.
installSystemModulesbooleanfalseIf true then it will install: commandbox-cfconfig, commandbox-dotenv for you
installstring---If added, a comma-delmitted list of packages to install upon installation of the binary for you.
warmupbooleanfalseIf true and no install inputs detected, it will run the box binary.
versionsemverlatestThe CommandBox version to install, if not passed we use the latest stable.

Usage

Simple usage:

- name: Setup CommandBox
  uses: Ortus-Solutions/[email protected]

With Global Dependencies:

- name: Setup CommandBox
  uses: Ortus-Solutions/[email protected]
  with:
    installSystemModules: true

With Specific Dependencies:

- name: Setup CommandBox
  uses: Ortus-Solutions/[email protected]
  with:
    install: commandbox-fusionreactor

With ForgeBox Token

- name: Setup CommandBox With ForgeBox Key
  uses: Ortus-Solutions/[email protected]
  with:
    forgeboxAPIKey: my-token

Install a specific version of CommandBox

- name: Setup CommandBox With ForgeBox Key
  uses: Ortus-Solutions/[email protected]
  with:
    version: 5.0.0