ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 16:27:13 +03:00
Code Issues Projects Releases Wiki Activity

Added docs for windows build action

Browse Source
This commit is contained in:
A_D 2020-12-08 19:59:41 +02:00
parent cabf7289cb
commit 3a980ef16a
No known key found for this signature in database
GPG Key ID: 4BE9EB7DF45076C4
2 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/Automatic Builds.md Normal file
View File

@ -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.**

2
docs/Releasing.md
View File

@ -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