Skip to content
Snippets Groups Projects
Commit 8ac8d4ee authored by David Gilbert's avatar David Gilbert :bug:
Browse files

Update README.md

parent 5ce1b072
No related branches found
No related tags found
No related merge requests found
# GitLab CI Unreal Files # GitLab CI Unreal Files
In this repository the shared scripts, the launcher meta data file and two sample `.gitlab-ci.yml` files are stored. If you just want an automatic compile and deploy of your project to the CAVE and the VRDev network drive, copy the `project.gitlab-ci.yml` and `launcher.meta` to your projects root, rename `project.gitlab-ci.yml` to `.gitlab-ci.yml` and set up a scheduled build in the project preferences. In this repository the shared scripts, the launcher meta data file and two sample `.gitlab-ci.yml` files are stored. If you just want an automatic compile and deploy of your project to the CAVE (vrdemo or av006de) and the VRDev network drive, copy the `project.gitlab-ci.yml` and `launcher.meta` to your projects root, rename `project.gitlab-ci.yml` to `.gitlab-ci.yml` and set up a scheduled build in the project preferences. You can use the `UNREAL_VERSION` variable in said .yml configurations to define your required Unreal version.
If you need more information, have a look into the wiki [here](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unreal-ci/-/wikis/Setting-up-the-Pipeline-for-your-Project)! If you need more information, have a look into the wiki [here](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unreal-ci/-/wikis/Setting-up-the-Pipeline-for-your-Project)!
```mermaid ```mermaid
...@@ -40,17 +40,22 @@ Specific for these Plugins the Generation Stage is provided, which generates a p ...@@ -40,17 +40,22 @@ Specific for these Plugins the Generation Stage is provided, which generates a p
In the `.gitlab-ci.yml` references to the shared scripts of this repository are defined. If you need to change something of the premade pipeline, have a look into this file. In the `.gitlab-ci.yml` references to the shared scripts of this repository are defined. If you need to change something of the premade pipeline, have a look into this file.
You can alter/remove the stages and add extra jobs per stage. Predefined stages are at the moment the You can alter/remove the stages and add extra jobs per stage. Predefined stages are at the moment the
.Generate_Project_, .Build_Windows_, .Build_CentOS_, .Deploy_VRDev_, .Deploy_CAVE_ .Generate_Project_, .Build_Windows_, .Build_CentOS_, .Deploy_VRDev_, .Deploy_CAVE_, .Deploy_vrdemo_
stages, which are referenced by the ones in the sample files. stages, which are referenced by the ones in the sample files.
.Deploy_CAVE_ deploys to legacy av006de, whereas .Deploy_vrdemo deploys to the shared vrdemo file system
If you dont need specific jobs, for example a Linux build, then please consider to comment out the jobs in your local file to speed up the pipeline. If you dont need specific jobs, for example a Linux build, then please consider to comment out the jobs in your local file to speed up the pipeline.
The `UNREAL_VERSION` variable can be used to adjust the required Unreal Version with which the project should be built.
### Build Steps ### Build Steps
For the predefined build steps you can change the `CLIENT_CONFIG` to either `DebugGame` or `Shipping` (Default). Additionally, you can add parameters to the build command by specifying the `EXTRA_ARGS` variable. If you need to change the whole command, manually "fork" the job by copying the script part to your local file and removing the extends line. For the predefined build steps you can change the `CLIENT_CONFIG` to either `DebugGame` or `Shipping` (Default). Additionally, you can add parameters to the build command by specifying the `EXTRA_ARGS` variable. If you need to change the whole command, manually "fork" the job by copying the script part to your local file and removing the extends line.
### Deploy Steps ### Deploy Steps
The predefined deploy steps are a bit more tricky to alter. So just try not to. The predefined deploy steps are a bit more tricky to alter. So just try not to.
The two predefined deploy stages are automatically deploying the builds (if successful) to either */home/av006de/demos_UNREAL/CI* (CAVE, CentOS) or */home/vrdev/UnrealCIDeploy* (VRDev, Win64). The two predefined deploy stages are automatically deploying the builds (if successful) to */work/vrdemo/projects/ci* or */home/av006de/demos_UNREAL/CI* (CAVE, CentOS, Deprecated) or */home/vrdev/UnrealCIDeploy* (VRDev, Win64).
--- ---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment