GitHub CLI with YAML

YAML parameters for GitHub CLI

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Must be set to `GIT_HUB_CLI`.
shell	String	The name of the shell that will be used to execute commands. Can be one of `BASH` (default) or `SH`.
setup_commands	String[]	The command that will be executed only on the first run.
execute_commands `Required`	String[]	The commands that will be executed.
integration `Required`	String	The ID of the integration.

YAML example for GitHub CLI

yaml
- action: "Run GitHub CLI command"
  type: "GIT_HUB_CLI"
  trigger_time: "ON_EVERY_EXECUTION"
  shell: "BASH"
  setup_commands:
  - "apt-get update && apt-get -y install git"
  execute_commands:
  - "gh repo list"
  integration: "my_integration"

Last modified on Mar 4, 2025

Gitcrypt unlock GitHub Release

On this page

YAML parameters for GitHub CLI YAML example for GitHub CLI