Build Steps

Build steps are the commands run to build a Probo environment and run any additional tests in that environment. Steps are identified by their name and a plugin declaration, and each step can have one or many parameters.

Name

steps:
  - name: Say Hello

A step’s name should provide context for the actions being performed. Each step appears in build status interfaces on the pull request and the Probo Portal.

Plugin

steps:
  - name: Say Hello
    plugin: Shell

Each step also has a plugin. When you define a plugin for the step, you get access to that plugin’s set of build parameters.

The default plugin is Shell. You can use multiple plugins in your configuration file, but you must declare the plugin used for each step before its parameters. Plugin names are case-sensitive. For example, this means that shell will not work.

Parameters

steps:
  - name: Say Hello
    plugin: Shell
    command: echo 'Hello, World!'

These are the actual commands that are run to build your environments. The Shell plugin provides the default command parameter that can be used to run bash commands. Depending on the plugin you specify for your build step, you will have access to various other parameters. You may only declare a parameter once per step.

Conditional Branching

By default, every step runs on every build, but you can restrict an individual step to certain branches. Adding a branches (allow-list) or skipBranches (deny-list) key to a step tells Probo.CI to run or skip that step based on the build’s branch, and both keys accept a single branch name, a list of names, or * wildcards such as release/*. This is handy for steps you only want on specific branches - deploying only from main, or seeding demo content everywhere except release branches. For the full set of rules, including how wildcards match and what happens on builds without branch context, see Restricting Build Steps by Branch.

See the Plugins section for a list of available plugins and their parameters.

Related Articles & Information

---

Restricting Build Steps by Branch