Travis CI
| Travis CI is no longer supported in the 20210131 and newer Mod SDK releases. The Mod SDK now integrates with GitHub Actions, which do not require this manual configuration. |
Travis CI is a free continuous integration service that integrates well with GitHub. The OpenRA Mod SDK includes a default Travis configuration file that:
- Tests your mod for known common errors when you push a new commit
- Automatically generates installers for Windows and macOS when a Git tag is pushed to the repository
The guide below explains how to enable Travis CI on your mod repository:
- Go to https://github.com and log in with your GitHub account
- Open your profile settings by hovering over your name/picture in the top-right corner and selecting Settings
- Select Personal access tokens from the sidebar:
- Generate a new token, enabling the
public_reposcope:
- Copy the generated code.
- Go to https://travis-ci.org/ and log in with your GitHub account.
- Open your profile settings by hovering over your name/picture in the top-right corner and selecting Accounts
- Toggle the slider to enable travis-ci on your mod repository (select your mod Organization from the left sidebar if necessary):
- Press the gear icon next to the slider to enter the mod repository settings page
- Configure the build settings as follows:
- Add an environment variable with the name GH_DEPLOY_API_KEY and for its value paste the GitHub API token that you created above. Make sure that "Display value in build log" is disabled. Don't forget to press the Add button!
You're now ready to go! View the status of your latest commits from the Travis-CI dashboard, or push a git tag to automatically generate mod installers!
For more information refer to the following links: