Action definition

Custom actions are defined with three elements:

1. YAML configuration (required). Must be named action.yml.
2. Icon (optional)
3. Description (optional)

All three must be uploaded to the default branch of the repository:

1. The root directory of the repository (single action)
2. The .buddy/actions directory, with each action in its own subdirectory (multiple actions), for example:

.buddy/actions/myaction-1
.buddy/actions/myaction-2

The folder with the action definition, icon, and description should look like this:

/action.yml
/action.png
/README.md

Once uploaded, Buddy will automatically parse the action and display it at the top of the action list:

Custom actions on action list

Icon

The icon is displayed on the action's tile and configuration screen.

• name: must be action
• extension: jpg, jpeg, png, svg
• size: 40x40 px min., scalable

Description

An action can have a description in the form of a README.md file. We recommend uploading such file to your action directory with a description of what the action does and required parameters, commands, and variables. You can also add a changelog with the list of updates to track how your action evolves.