diff options
Diffstat (limited to 'docs/dev/Deploy.md')
| -rw-r--r-- | docs/dev/Deploy.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/dev/Deploy.md b/docs/dev/Deploy.md new file mode 100644 index 000000000..2a5e9be0f --- /dev/null +++ b/docs/dev/Deploy.md @@ -0,0 +1,31 @@ +# Deploying a build to UE + +## Build + +Builds are produced via GitHub CI (Action Runners) and uploaded as artifacts +to GitHub. See [create_release.yml](.github/workflows/create_release.yml) for +details on what happens during the build. + +A new release is created when the [VERSION.txt](VERSION.txt) file changes. + +## Deploying into the UE tree + +After a successful release, you need to integrate the resulting binaries into +the UE tree. There's a helper script for this in [scripts/download_artifacts.py](scripts/download_artifacts.py) + +You'll need a p4 workspace mapped to the stream or branch you want to deploy +into, and a clone of the zen git repo. Since we use `gh` to download the +artifacts you'll need to use `gh auth login` and `gh repo clone` to clone +the repo. With the current directory set to the root of the cloned git repo, +run the following command to download the artifacts corresponding to the +VERSION.txt in the repo by default. + +```bash +> python scripts/download_artifacts.py <UE root path> +``` + +The script should go ahead and for each platform downloads the artifacts +using `gh artifact download` to a temporary directory, sync the corresponding +files in Engine/Binaries/<platform> to #head and opens them for edit and +copies the downloaded binaries into place, leaving the changes in your default +changelist. |