See CI results and nightly builds next to your changelists
For whoever runs the studio's CI, and the LEAD who sets it up. Two HTTPS calls per run, one at the start and one at the end, from Jenkins, TeamCity, GitHub Actions, GitLab CI, Horde or any script. Gameheim never builds: it shows the outcomes where the team already looks and turns a broken build into a bug with one click.
A red nightly build is easy to miss
The nightly build breaks, and the first to notice is often a tester the next morning. Then someone has to find which changes went in since the last good build, who made them, and open a bug by hand.
The CI knows the outcome and the production tool knows the changelists, the people and the bugs. Keeping the two in step by hand costs time on exactly the mornings when time is short.
How Gameheim uses the outcome of each run
Your CI reports each run with a key of the project. A run belongs to a line: the same job, stream, platform and configuration. When a line goes from green to red, Gameheim treats it as a broken build.
How to connect your CI to Gameheim
- The Integrations permission on the project (
integrations:manage), which manages both the Discord and Slack channels and the CI key. LEAD and ADMIN have it. - Your organization's plan includes CI build results.
- A CI that can make an HTTPS call at the start and at the end of a job.
Generate the CI key
Open Integrations, choose CI build results and click Generate the CI key. Copy it into your CI's secrets as
GAMEHEIM_CI_KEYright away: it is shown only this once.Copy the example for your CI
Under Examples, pick Jenkins, TeamCity, GitHub Actions, GitLab CI, Horde / BuildGraph, bash or PowerShell and click Copy the example. Each one makes two calls: one when the run starts, one when it ends.
Send the revision the run built
- Perforce: the changelist the run synced, and the stream exactly as the changelist feed shows it (for example
//Ocean/Main). With another spelling the badges stay on waiting. - Git: the full commit id the run built. On Git, an agent with the project's clone answers which commits a run contains, so keep one online.
- Platform (for example Win64) and, if you build several, the configuration (for example Shipping).
- Optional: the version name of the build, and a link to the log.
- Perforce: the changelist the run synced, and the stream exactly as the changelist feed shows it (for example
Optional: store the error excerpts
The examples also send the last lines of a failed build's log. Turn on Store the error excerpts to keep them: they are encrypted and shown only to people who can see the run's changelist. Logs can contain internal paths, so the choice is yours.
Check the first run
Run the job. Last used on the CI card shows the time of the call, and the changelist or commit in the feed gets its first build badge.
Who sees what
Build badges appear only on the changelists and commits a person already sees in the feed. Someone who cannot see a restricted changelist sees the run without its number, marked not visible, and without its error excerpt. The notice about a broken build goes only to authors whose Perforce or Git account is verified as theirs and who can see that changelist.
The log link and the error excerpt never go to Discord or Slack. A broken-build message carries the job, the platform, the revision and the authors the channel is allowed to see.
Reference: what the CI sends
| Field | Value |
|---|---|
runId | The CI's own id of the run, the same in both calls |
job, platform, configuration, stream | What makes the line of the run |
status | RUNNING at the start; SUCCESS, FAILURE or CANCELED at the end |
changelist or commit | The revision the run built |
version | Optional: the version name of the build |
logUrl | Optional: an http or https link to the log |
errorExcerpt | Optional, only for a failure: the last lines of the log |
The key travels in the Authorization: Bearer header, never in the address. A run that ends is final: sending it again changes nothing. A CI that only reports the end of a run works too.
Frequently asked questions
Does Gameheim start builds or need access to our build machines?
No. Your CI calls Gameheim; Gameheim never calls the CI, never builds and keeps no packages.
Which CI systems work?
Any CI that can make an HTTPS call. The Integrations page has ready examples for Jenkins, TeamCity, GitHub Actions, GitLab CI, Horde / BuildGraph, bash and PowerShell.
How does Gameheim know who broke the build?
It lists the changes between the last good build of the line and the first red one, with their authors. It does not guess a single culprit.
What happens if the key leaks?
Click Regenerate or Revoke on the CI card: the old key stops working at once.
