Configuring the .probo.yaml File

As you create the .probo.yaml file for your application, you can use our Checking & Debugging YAML guide to validate your configuration and quickly track down syntax errors.

After you have synced your repos to Probo, you need to create a .probo.yaml configuration file. This file tells Probo how to configure and build your test environments.

Create a .probo.yaml File

In a new branch, create a .probo.yaml file in the root of your codebase. The .probo.yaml file is split into a section for declaring Assets, a section for defining Steps, and any environment configuration options.

Assets

assets:
  - mydb.sql.gz

Assets are any files you want available to your Probo environments that are not found within your repository. For example, a database is an important asset for many web applications. These assets must be uploaded to Probo before they can be used in a build. See the Assets section for details on uploading assets and adding them to the configuration file.

Steps

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

Steps are the commands Probo runs to configure and build your environment. Each step uses a plugin and reports its own pass or fail status.

Steps can also be restricted to run only on certain branches. See Branch Filtering for details.

Sample

Here is a sample .probo.yaml file that installs a Drupal website from scratch.

type: lamp
php: 8.4
database: mysql:8.4

steps:
  - name: Install Drupal 11 Files
    plugin: Script
    script: |
      rm -rf /var/www/html
      cd $SRC_DIR
      composer create-project drupal/recommended-project:11 docroot
      cd /src/docroot
      composer require drush/drush:^12 drupal/admin_toolbar
      chmod -R 777 /src/docroot/web/sites/default

  - name: Set Up Database For Drupal 11
    plugin: Drupal
    drupalVersion: 11
    subDirectory: docroot/web

  - name: Run the Drupal 11 Site Installation
    plugin: Script
    script: |
      cd /var/www/html
      drush si -y --account-name=admin --account-mail=joeblow@example.com --site-mail=joeblow@example.com --account-pass=password --site-name="Probo Drupal 11 Site Install"
      drush pm:enable -y admin_toolbar
      chmod 755 /src/docroot/web/sites/default/settings.php

You can task Probo to run any number of build steps to successfully create testing environments. Each step you define will get a status update sent to the Probo Portal as well as your git hosting provider.

Create a Pull Request

Create a pull request for the branch that includes the .probo.yaml file. You should see the steps in your .probo.yaml file building both on your pull request and in the Probo Portal. If all your steps pass, you can view the build and begin testing. If a step fails, look at the details in the Probo Portal for the full console output to begin troubleshooting.

Iterate for a Successful Build

If your build fails, check the output in the Probo Portal to help you diagnose what went wrong. Adjust your .probo.yaml to correct any errors, or contact us for support. Whenever you commit a change to a branch with an open pull request, a new build will be created. Repeat the process until all steps have passed and your build is successful. When sending a request for support, please be sure to include your .probo.yaml file to help us triage.

Related Articles & Information

---

Checking & Debugging YAML Database Configuration