Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 2.45 KB

README.md

File metadata and controls

90 lines (66 loc) · 2.45 KB

KMP Build Web App GitHub Action

Overview

This GitHub Action is designed to build a Kotlin Multiplatform (KMP) web application using Gradle. It automates the process of setting up the development environment, caching dependencies, and packaging the web application.

Inputs

web_package_name

Required: Yes

  • Description: Name of the web project module
  • Used to specify the correct path for building and uploading the web app artifact

Outputs

artifact-name

  • Description: Name of the generated artifact
  • Value: web-app

Action Workflow

flowchart TD
    A[Start Action] --> B[Set up Java Development Environment\nJava 17 with Zulu OpenJDK]
    B --> C[Setup Gradle]
    C --> D[Cache Gradle Dependencies]
    D --> E[Run jsBrowserDistribution\nPackage Web Application]
    E --> F[Upload Web App Artifact]
    F --> G[End Action]
Loading

The action performs the following steps:

  1. Set up Java Development Environment

    • Uses Zulu distribution of OpenJDK
    • Configures Java version 17

  2. Setup Gradle

    • Prepares Gradle for building the project

  3. Cache Management

    • Caches Gradle dependencies, build outputs, and Kotlin/Native artifacts
    • Speeds up subsequent builds by reusing cached components
    • Caches include:
      • Gradle caches
      • Gradle wrapper
      • Kotlin/Native artifacts
      • Build directory

  4. Package Web Application

    • Runs ./gradlew jsBrowserDistribution to create the web app distribution

  5. Artifact Upload

    • Uploads the web app artifact from the specified module's build directory

Usage Example

name: Build Web App

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: openMF/[email protected]
        with:
          web_package_name: 'web'

Requirements

  • GitHub Actions runner with bash support
  • Gradle project configured for Kotlin Multiplatform
  • Java 17
  • Zulu OpenJDK distribution

Best Practices

  • Ensure your Gradle build scripts are configured for JS browser distribution
  • Verify that the web_package_name matches your project's module structure
  • Use consistent Gradle and Java versions across local and CI environments

Troubleshooting

  • Check Gradle logs if the build fails
  • Verify that the jsBrowserDistribution task is correctly configured in your build script
  • Ensure all necessary dependencies are declared in your Gradle files