Comment on page

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
Setup CommandBox Action
Githb Action Marketplace

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.
Input
Type
Default
Description
forgeboxAPIKey
string
---
If added to the action, we will seed it in CommandBox for you.
installSystemModules
boolean
false
If true then it will install: commandbox-cfconfig, commandbox-dotenv for you
install
string
---
If added, a comma-delmitted list of packages to install upon installation of the binary for you.
warmup
boolean
false
If true and no install inputs detected, it will run the box binary.
version
semver
latest
The CommandBox version to install, if not passed we use the latest stable.

Usage

Simple usage:
- name: Setup CommandBox
uses: Ortus-Solutions/setup-[email protected]
With Global Dependencies:
- name: Setup CommandBox
uses: Ortus-Solutions/setup-[email protected]
with:
installSystemModules: true
With Specific Dependencies:
- name: Setup CommandBox
uses: Ortus-Solutions/setup-[email protected]
with:
install: commandbox-fusionreactor
With ForgeBox Token
- name: Setup CommandBox With ForgeBox Key
uses: Ortus-Solutions/setup-[email protected]
with:
forgeboxAPIKey: my-token
Install a specific version of CommandBox
- name: Setup CommandBox With ForgeBox Key
uses: Ortus-Solutions/setup-[email protected]
with:
version: 5.0.0