Quickstart

Deliverybot is a GitHub App. To get started with deployments you need a repository with the Deliverybot app installed on it. The steps below use the hosted app at app.deliverybot.dev and one of the example repositories. Prefer to run it yourself? See self-hosting.

1. Fork the example repository

Fork the example repository. Its deployments don’t go anywhere, but it shows the whole flow.

2. Install the Deliverybot GitHub App

Install the app and give it access to your fork. Deliverybot only needs read access to code to see pushes and to read .github/deploy.yml; see the security overview for every permission it asks for.

3. Push a commit to watch the workflows kick off!

Go to your repository and push a commit, then open the dashboard to watch the deployment and deploy any commit with a click.

4. Install integrations

Install integrations like Slack or Helm to build a workflow for your team. Visit our integrations page for more information.

Next

Once you have a working example read through the guide for more information on how to setup complex workflows.