Skip to content

Config

Add a .github/deploybot.yaml file to a GitHub repository to define an ordered set of deploy environments.

```yaml deployments: - name: development description: development # Automatically trigger deploy on default branch passing on_push: true

  • name: staging description: staging # auto-deploy from the staging branch to the staging environment, when tests pass on_push: true on_push_branch: staging

  • name: production description: production # requires a manual deploy ```

  • deployments - a list of deployment objects (displayed in order in deploybot.app)

    • name (required) - name of the deployment GitHub Environment
    • description (optional) - short description (used by some automation platforms)
    • on_push (optional) - enable auto-deploying when a push to a branch passes tests. Defaults to false, so deploys are only done manually.
    • on_push_branch (optional) - specify an auto-deploy branch by name (defaults to the default branch)

Examples

Enable auto-deploys from a named branch (e.g. "staging") to an environment (staging).

```yaml

Deploybot config

deployments: - name: staging # auto-deploy from the staging branch to the staging environment, when tests pass on_push: true on_push_branch: staging ```