Builders are used to clone your custom Runtime Code written in TypeScript, Go, and Lua. A builder represents the “Continuous Integration” portion of a traditional CI/CD pipeline. Deployment is a separate process and must be triggered manually.
Builders conditionally compile your code against a selected Nakama image and package it into a Docker image. Your 20 most recent builder images are stored at all times.
These images are then available for deployment in your project’s Configuration tab, enabling you to quickly deploy a new image or return to a previous one whenever needed.
Each tile on the dashboard provides the details of the corresponding builder:
- Status: Icon indicates the status of the most recent build process.
- Builder name: The name of this builder, used to build the resultant image. This cannot be edited once set.
- Organization: The organization this builder belongs to.
- Description: The user provided builder description.
- Repository: The Git repository this builder is linked to.
- Branch Nakama Version: The Nakama version associated with this builder. Any custom code must use the same Nakama version.
Creating builders #
You can create a new builder from your Organization or Builders dashboards.
- From the dashboard page, select the New Builder tile. The Create your Builder page is displayed.
- Provide the following details for your new builder:
- Organization: The Organization this builder will be associated with. Use the drop-down to select from your available Organizations.
- Builder Name: Enter a unique identifier for your builder. This name will be used for the Docker images created by this builder. Only alphanumeric characters may be used and cannot exceed 20 characters in length.
- Description: Enter a short description of this builder for easy identification.
- Nakama Image: Use the drop-down to select the Nakama version this builder will use.
- Click Create to finalize your new builder, then proceed to the builder details page to connect it to your desired repository and complete setup.
Connecting to source control #
To link your new builder to a desired repository, navigate to the Edit tab in your builder settings:
Use the drop-down of your source control provider (Git) to enter your connection details, then click Connect.
Triggering new builds #
New builds are not automatically triggered with new commits to the connected repository, they must be started manually.
To trigger a new build:
- Navigate to the Trigger tab of the desired builder.
- It is good practice to use the Refresh Commits button to ensure all recent activity in the connected repository is reflected.
- Using the input field or provided table select the Commit SHA to use for the new build.
- Click Trigger to start building the new image.
- From the Info tab you can watch the builder status as it completes.