The Commando.io GitHub App allows you to trigger executions on servers when you push to GitHub repositories.

Installation

Navigate to https://github.com/apps/commando-io and click the Install button. You can grant the Commando.io GitHub App accesss to a specific list of repositories, or allow it access to all repositories in an orgnization.

Configuration

The Commando.io GitHub App is configured via a YAML file in the repository tree master branch.

• Create a YAML file in .github/commando.yml in the master branch. The file must exist in a base directory .github and exactly named commando.yml. It must also exist in the master branch only. The GitHub integration can only read the configuration from the master branch.

Example commando.yml files

Execute recipe id rec_3Fc5q540e480b672d38Ig on group id grp_2Xk7x540e481bcb9c775d exiting on stderr and with some notes when pushing to the master branch.

master:
  api_token_secret_key: skey_2azljcEZBjjxKQ53cf5cc807a673EqqdNmT
  account_alias: foo
  recipe: rec_3Fc5q540e480b672d38Ig
  groups:
    - grp_2Xk7x540e481bcb9c775d
  halt_on_stderr: true
  notes: master branch execution

You can also define different executions based on a branch such as new-feature.

master:
  api_token_secret_key: skey_2azljcEZBjjxKQ53cf5cc807a673EqqdNmT
  account_alias: foo
  recipe: rec_3Fc5q540e480b672d38Ig
  groups:
    - grp_2Xk7x540e481bcb9c775d
  halt_on_stderr: true
  notes: master branch execution

new-feature:
  api_token_secret_key: skey_2azljcEZBjjxKQ53cf5cc807a673EqqdNmT
  account_alias: foo
  recipe: rec_3Fc5q540e480b672d38Ig
  server: srv_9GkE2IWvkzItmaTs5Agn8
  notes: new-feature branch execution

Finally, there is a special catch all _all_ you can use to run an execution on all branches. Note, specifically defined branches (master, new-feature) take precedence over _all_.

master:
  api_token_secret_key: skey_2azljcEZBjjxKQ53cf5cc807a673EqqdNmT
  account_alias: foo
  recipe: rec_3Fc5q540e480b672d38Ig
  groups:
    - grp_2Xk7x540e481bcb9c775d
  halt_on_stderr: true
  notes: master branch execution

new-feature:
  api_token_secret_key: skey_2azljcEZBjjxKQ53cf5cc807a673EqqdNmT
  account_alias: foo
  recipe: rec_3Fc5q540e480b672d38Ig
  server: srv_9GkE2IWvkzItmaTs5Agn8
  notes: new-feature branch execution

_all_:
  api_token_secret_key: skey_2azljcEZBjjxKQ53cf5cc807a673EqqdNmT
  account_alias: foo
  recipe: rec_3Fc5q540e480b672d38Ig
  recipe_arguments:
    $count: 1
    $host: google.com
  server: srv_9GkE2IWvkzItmaTs5Agn8
  notes: all branches execution