From 9643dd397f73a1db30621790494c5c2a9725d8b8 Mon Sep 17 00:00:00 2001 From: Akos Kitta <1405703+kittaakos@users.noreply.github.com> Date: Thu, 21 Nov 2019 11:16:52 +0100 Subject: [PATCH] [doc]: Updated the CI section. Documented when do we build the electron-based applications. --- electron/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/electron/README.md b/electron/README.md index 65d5bc67..062f8757 100644 --- a/electron/README.md +++ b/electron/README.md @@ -6,7 +6,7 @@ All-in-one packager producing the `Arduino Pro IDE` Electron-based application. The prerequisites are defined [here](https://github.com/theia-ide/theia/blob/master/doc/Developing.md#prerequisites). -### Build: +## Build To build the Arduino Pro IDE application you have to do the followings: ```bash yarn --cwd ./electron/packager/ && yarn --cwd ./electron/packager/ package @@ -14,12 +14,14 @@ yarn --cwd ./electron/packager/ && yarn --cwd ./electron/packager/ package The packaged application will be under the `./electron/build/dist` folder. -### CI: +## CI +We always build an electron-based application for Windows. Create a PR, and the CI will automatically create the app for Windows. Do you need the builds for macOS and Linux? Start a build manually. + The electron packager runs when: - the build is manually triggered by the user, or - on scheduled (CRON) jobs. -### Creating a Release Draft: +## Creating a Release Draft One can create a GitHub release draft, tag the source, and upload the artifacts to GitHub with Azure. - Go to the Azure [build](https://dev.azure.com/typefox/Arduino/_build) page. - Click on `Queue` in the top right corner. @@ -32,7 +34,7 @@ One can create a GitHub release draft, tag the source, and upload the artifacts - 🎈🎉 -### Publishing the Release Draft: +## Publishing the Release Draft One has to manually publish the GitHub release. - Go to the [release page](https://github.com/bcmi-labs/arduino-editor/releases) of the `arduino-editor` repository. - Select your release draft.