Skip to content

Commit 9643dd3

Browse files
authored
[doc]: Updated the CI section.
Documented when do we build the electron-based applications.
1 parent 7c1ebf2 commit 9643dd3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

electron/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,22 @@ All-in-one packager producing the `Arduino Pro IDE` Electron-based application.
66

77
The prerequisites are defined [here](https://github.com/theia-ide/theia/blob/master/doc/Developing.md#prerequisites).
88

9-
### Build:
9+
## Build
1010
To build the Arduino Pro IDE application you have to do the followings:
1111
```bash
1212
yarn --cwd ./electron/packager/ && yarn --cwd ./electron/packager/ package
1313
```
1414

1515
The packaged application will be under the `./electron/build/dist` folder.
1616

17-
### CI:
17+
## CI
18+
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.
19+
1820
The electron packager runs when:
1921
- the build is manually triggered by the user, or
2022
- on scheduled (CRON) jobs.
2123

22-
### Creating a Release Draft:
24+
## Creating a Release Draft
2325
One can create a GitHub release draft, tag the source, and upload the artifacts to GitHub with Azure.
2426
- Go to the Azure [build](https://dev.azure.com/typefox/Arduino/_build) page.
2527
- 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
3234
- 🎈🎉
3335

3436

35-
### Publishing the Release Draft:
37+
## Publishing the Release Draft
3638
One has to manually publish the GitHub release.
3739
- Go to the [release page](https://github.com/bcmi-labs/arduino-editor/releases) of the `arduino-editor` repository.
3840
- Select your release draft.

0 commit comments

Comments
 (0)