Action definition
Custom actions are defined with three elements:
- YAML configuration (required). Must be named
action.yml
. - Icon (optional)
- Description (optional)
All three must be uploaded to the default branch of the repository:
- The root directory of the repository (single action)
- 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:
Image loading...Custom actions on action list
Tip
Added actions become available for all projects in the workspace. However, we do recommend storing your actions in a dedicated repository. This way you can easily track their development history, release updates, and fix issues while keeping them isolated from your source code. You can also share the actions from this repository across several workspaces if required.
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
Hint
When no icon is provided, Buddy will use the default system icon for custom actions.
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.
Last update:
Sep 24, 2024
Sep 24, 2024