Skip to main content

Installation guide

Welcome to Unity PR Bot!

There are four requirements to have the bot running. These are:

  • Installing the GitHub App
  • Creating the unity-ci.json file.
  • Setting the Unity Cloud API Key in the dashboard.
  • You must not be using forks for your Pull Requests.

Installing the GitHub App​

To install the GitHub you must go to https://github.com/apps/unity-pr-bot and install it in the desired organization.

Creating the unity-ci.json file.​

The unity-ci.json file contains all the required configuration for the Unity PR Bot to generate builds.

For more information go into Configuration File

You can also use the config generator tool to generate the required file.

Setting the Unity Cloud API Key​

To set up the Unity Cloud API Key you must go into the user dashboard.

You can see a step by step guide in Setting Unity Cloud Key

Executing the bot

Once you have done all the required configuration, when you create a PR in a repo that has the config file, UnityPRBot will trigger a build automatically and report it in a status check.

Now you can merge with confidence!