HelloGluon CI

This sample shows how to automatically build a Gluon Application using Github Actions.

It uses a version of HelloGluon, a Hello World application with Java 11+, JavaFX 15+, Gluon Mobile and GraalVM. For more details about Gluon Applications in general, please have a look at the Gluon docs or the other samples.

This sample focuses on the continuous integration using Github Actions on these platforms:

Windows
MacOS
Linux
iOS
Android
Embedded - AArch64 Linux

All these platform specific workflows share these common steps:

Checkout your code
Setup the build environment, specific to the platform
Build the application
Upload the application

Next to the above steps, for iOS and Android, the workflow includes steps to properly sign and upload the binary to the Play Store and App Store.

Build setup

Building using Github Actions is not very different from building locally.

On top of a default Gluon application, the following releaseConfiguration was added to the maven-gluonfx-plugin configuration:

<configuration>
    <releaseConfiguration>
        <!-- for iOS -->
        <bundleVersion>${env.GITHUB_RUN_NUMBER}</bundleVersion>
        
        <!-- for Android -->
        <versionCode>${env.GITHUB_RUN_NUMBER}</versionCode>
        <providedKeyStorePath>${env.GLUON_ANDROID_KEYSTOREPATH}</providedKeyStorePath>
        <providedKeyStorePassword>${env.GLUON_ANDROID_KEYSTORE_PASSWORD}</providedKeyStorePassword>
        <providedKeyAlias>${env.GLUON_ANDROID_KEYALIAS}</providedKeyAlias>
        <providedKeyAliasPassword>${env.GLUON_ANDROID_KEYALIAS_PASSWORD}</providedKeyAliasPassword>
    </releaseConfiguration>
</configuration>

For iOS:

bundleVersion is set to the GITHUB_RUN_NUMBER, so each build will have unique CFBundleVersion. See this doc for more information.

For Android:

versionCode is set to the GITHUB_RUN_NUMBER, so each build will have a unique android:versionCode. See this doc for more information.
keystore configuration are taken from env variables, that will be set by the workflow action.

Gluon license

All workflows use this action this Gluon license action:

  - name: Gluon License
    uses: gluonhq/gluon-build-license@v1
    with:
      gluon-license: ${{ secrets.GLUON_LICENSE }}

Using a Gluon license is optional and depends on your situation. Have a look at the Gluon website for more information about licences or contact us.

Platforms

Github Action workflows are specified in .github/workflows and configured to be triggered on push. Depending on your own preference and requirements, this can of course be changed. Please refer to the GitHub Actions documentation for more information.

Windows

Workflow file: .github/workflows/windows.yml
Detailed documentation: Gluon documentation for Windows for more detailed information.

MacOS

Workflow file: .github/workflows/macos.yml
Detailed documentation: Gluon documentation for Mac OS for more detailed information.

Linux

Workflow file: .github/workflows/linux.yml
Detailed documentation: Gluon documentation for Linux for more detailed information.

iOS

Workflow file: .github/workflows/ios.yml
Detailed documentation: Gluon documentation for iOS for more detailed information.

Android

Workflow file: .github/workflows/android.yml
Detailed documentation: Gluon documentation for Android for more detailed information.

Embedded - AArch64 Linux

Workflow file: .github/workflows/aarch64-linux.yml
Detailed documentation: Gluon documentation for Embedded - AArch64 Linux for more detailed information.

JavaMaxim / hello-gluon-ci