Skip to content

Builds

Jump to bottom
Falko edited this page Jun 16, 2023 · 9 revisions

Creating SEE executables

There are two main ways to create SEE executables:

  • via GitHub Actions, or
  • by creating the build locally.

Via CI (recommended)

Getting the latest master build is the easiest, since it is built automatically, otherwise, refer to "Manual build" below.

Builds will be deleted from GitHub 7 days after creation. This does not apply to release builds (see below).

Latest master

  1. Go to the SEE releases page. The most recent release will be at the top.
    • Note that it may take 1–2 hours after merging a Pull Request for a new release to be created.
    • If commits are made directly on master (rather than via a PR), no release will be created. See "Manual build" below to find out how to create a build as an artifact in cases like that.
  2. Under the release whose build you want to retrieve, scroll down to "Assets" and download the build for your desired platform.

Manual build

This should only be necessary if you want to create builds for a pull request that has not yet been merged into master.

A manual build can be triggered from the Actions tab:

  1. Under "Test and build SEE", click on "Run workflow".
  2. Select the branch and the platforms for which to build, and click "Run workflow" to start the build pipeline manually.
  3. Wait for a bit, it can take up to a minute for the new workflow to appear here. Once it has appeared, it should look like the following, which indicates the build is still being created:
    image
  4. Creating a build may take up to 45 minutes each (i.e., if you create both Windows and Linux builds, it may take 1.5 hours). Once the build is finished, the spinning yellow circle will be replaced with a green checkmark. Note that manually triggered builds only clone the repository and do not run any static checks or tests, so the run as a whole should not take much longer than 1.5 hours as well.
    • You may find that rather than a green checkmark, you get a red X, which means the build failed. Open the finished workflow run to find the reason why. If the error says something about "quota exceeded", you may need to delete existing artifacts, as we have a quota of about 2 GB, and each build artifact takes 1 GB of space.
  5. Click on the finished workflow run.
  6. On the page that should now be open, scroll down to the "Artifacts" section. You should be able to simply download your build here.

For more information, see this documentation page from GitHub.

Locally

  1. Open SEE in the Unity Editor.
  2. Open "File->Build Settings".
  3. Choose your desired platform (Windows and Linux builds are supported).
  4. Click on "Build", and select the directory in which to build SEE.
Clone this wiki locally