From 3a980ef16a1e701f9f4f3275dc4e03dcfc3dd693 Mon Sep 17 00:00:00 2001 From: A_D Date: Tue, 8 Dec 2020 19:59:41 +0200 Subject: [PATCH] Added docs for windows build action --- docs/Automatic Builds.md | 28 ++++++++++++++++++++++++++++ docs/Releasing.md | 2 ++ 2 files changed, 30 insertions(+) create mode 100644 docs/Automatic Builds.md diff --git a/docs/Automatic Builds.md b/docs/Automatic Builds.md new file mode 100644 index 00000000..a59f7505 --- /dev/null +++ b/docs/Automatic Builds.md @@ -0,0 +1,28 @@ +# Introduction + +Instead of building manually as laid out by [Releasing](https://github.com/EDCD/EDMarketConnector/blob/main/docs/Releasing.md), you can build the EDMC installer using github actions. + +## Initiating a workflow run + +Starting a workflow run is done from the Actions tab at the top of the main GitHub UI + +NB: The branch you want to build must have the workflow file (`.github/workflows/windows-build.yml`), and the version of the file in that branch is the version that will be used for the build (eg for different python versions) + +1. Select the Actions tab at the top of the main github interface +2. Select the `Build EDMC for windows` workflow on the left +3. Click the "Run workflow" button at the right side of the blue banner + 1. Select the branch you want to build + 2. Click the "Run Workflow" + +## Downloading built installer files + +When the workflow is (successfully) completed, it will upload the msi file it built as a "Workflow Artifact". You can find the artifacts as follows: + +1. Select `all workflows` on the left +2. Select the `Build EDMC for Windows` action +3. Select your build (probably the top one) +4. Find the `Built Files` artifact + +Within the `Built Files` zip file is the installer msi + +**Please ensure you test the built msi before creating a release.** diff --git a/docs/Releasing.md b/docs/Releasing.md index fb0623a3..8346d0ff 100644 --- a/docs/Releasing.md +++ b/docs/Releasing.md @@ -10,6 +10,8 @@ This document aims to enable anyone to quickly get up to speed on how to: Note that for Windows only a 32-bit application is supported at this time. This is principally due to the Windows Registry handling in config.py. +Builds can be run automatically from GitHub Actions. For more information on that process, see the [Actions docs](https://github.com/EDCD/EDMarketConnector/blob/main/docs/Releasing.md) + # Environment You will need several pieces of software installed, or the files from their