Continuous Integration
The Wonderland Editor Docker Image allows setting up efficient continuous integration and delivery of Wonderland Engine projects.
This page describes how to set up efficient automated builds and deployment with the most popular CI services:
Gitlab CI / Gitlab Pages
Using any docker runner (e.g. the gitlab.com shared runners) on Gitlab.
Configuration
Your .gitlab-ci.yml should look like follows:
stages:
- build
pages:
image: wonderlandengine/editor:latest
stage: build
tags:
- docker
script:
- WonderlandEditor --windowless --credentials "$WLE_CREDENTIALS" --package --project Project.wlp
- gzip -k deploy/*
- mv deploy public
cache:
key: ${CI_COMMIT_REF_SLUG}
paths:
- cache/
artifacts:
paths:
- public
$WLE_CREDENTIALS is a variable containing email:password. We will configure it in the next
step.
Variables
Find variables for Gitlab CI in the Gitlab web interface: Settings > CI/CD > Variables.
Click “Add Variable” and name it WLE_CREDENTIALS and set its value to email:password,
where email is the email of your Wonderland Engine account and password the matching
password.
For public projects make sure to enable “Protect variable” to prevent unmerged merge requests from being able to access the CI variable.
Cache
The most time-consuming task in the editor is compressing textures. This is significantly faster, if the results are cached (in the cache/ directory). It is therefore useful to either specify this folder for the CI cache, or check in the files into source control.
GitHub Workflows / GitHub Pages
Using any docker-enabled runner (e.g. the GitHub hosted runners) on GitHub.
Configuration
Your workflow file (e.g. .github/workflows/github-pages.yml) should look like follows:
on: [push]
jobs:
package:
runs-on: ubuntu-latest
container:
image: wonderlandengine/editor:latest
steps:
- uses: actions/[email protected]
- name: Package
run: /usr/local/bin/entrypoint.sh WonderlandEditor --windowless --package --project Project.wlp --credentials "$WLE_CREDENTIALS"
env:
WLE_CREDENTIALS: ${{ secrets.WLE_CREDENTIALS }}
- name: Gzip
run: gzip -k deploy/*
- name: Upload package artifact
uses: actions/[email protected]
with:
name: Project-deploy
path: deploy/
deploy:
needs: package
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- name: Download package artifact
uses: actions/[email protected]
with:
name: Project-deploy
path: deploy
- name: Deploy to GitHub Pages
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: deploy
Project-deploy is the name of the artifact which contains the contents of the deploy/ folder.
Project.wlp is your project file.
$WLE_CREDENTIALS is a secret containing email:password. We will configure it in the next
step.
Secrets
Find secrets for GitHub Workflows in the GitHub web interface: Settings > Secrets > Repository Secrets.
Click “New repository secret” on the top right and name it WLE_CREDENTIALS and set its value to email:password,
where email is the email of your Wonderland Engine account and password the matching password.
Secrets are not passed to pullrequests from forks, which means your workflow may not run for pullrequests from outside collaborators.
