flatpak-gradle-generator

A Gradle plugin to generate a sources file for offline Flatpak builds.

Example gradle.build:

plugins {
  id 'io.github.jwharm.flatpak-gradle-generator' version '0.1'
  id 'application'
}

repositories {
  mavenCentral()
  maven { url './maven-local' }
}

dependencies {
  // a random dependency for this example
  implementation 'io.github.jwharm.javagi:adw:0.7.1'
}

tasks.sourcesList {
  outputFile = file('flatpak-sources.json')
  downloadDirectory = './maven-local'
}

Run gradle sourcesList and it will write a json file with information about the dependencies:

[
  {
    "type": "file",
    "url": "https://repo.maven.apache.org/maven2/io/github/jwharm/javagi/adw/0.7.1/adw-0.7.1.module",
    "sha512": "d265d970864b3fb4c97b0fe87030ba76eafb252531d9da37cd7a51296b32e95bb70154f0075f6a0d0bc1e41fbd7f23280bdc6b317a1d5808c5a0c4b3a5ac70b5",
    "dest": "./maven-local/io/github/jwharm/javagi/adw/0.7.1",
    "dest-filename": "adw-0.7.1.module"
  },
  {
    "type": "file",
    "url": "https://repo.maven.apache.org/maven2/io/github/jwharm/javagi/adw/0.7.1/adw-0.7.1.jar",
    "sha512": "356a1c8f8ae89d7212bdfccd9afcd607ae86301485dd850d11eb378cbfe6f05f00cee27be368f907b0b941a065564f7ca3fb7ee18b21f4aaf8bec4d4176ba65a",
    "dest": "./maven-local/io/github/jwharm/javagi/adw/0.7.1",
    "dest-filename": "adw-0.7.1.jar"
  },
  {
    "type": "file",
    "url": "https://repo.maven.apache.org/maven2/io/github/jwharm/javagi/adw/0.7.1/adw-0.7.1.pom",
    "sha512": "7f62d93f16ba52cd88b690919219ee46b8507c71fcb77e295d42fb6724f27cda65b7a04673f35083a68d5f6b00aba4e2ef5cb37967d3c6c1687f92f640680a88",
    "dest": "./maven-local/io/github/jwharm/javagi/adw/0.7.1",
    "dest-filename": "adw-0.7.1.pom"
  },
  {
    "type": "file",
    "url": "https://repo.maven.apache.org/maven2/io/github/jwharm/javagi/gtk/0.7.1/gtk-0.7.1.module",
    "sha512": "ba28d5819b5765133be9d6be804f1688673f79315f06023452ad30ed61872a29a56013e7f24b05129b8c8f6d0d3350c042bc5e9170e005143b7511ba0458b275",
    "dest": "./maven-local/io/github/jwharm/javagi/gtk/0.7.1",
    "dest-filename": "gtk-0.7.1.module"
  },
  ...etc...

The plugin will output all direct and transitive dependencies for all build configurations, including plugin dependencies.

The generated file can be used in a Flatpak build process to download Maven dependencies before an offline build starts. The downloaded artifacts are pom, jar and module files and will be stored in a Maven repository layout.

Modular builds

In a modular Gradle build, you can add a tasks.sourcesList {} block in the build files of the subprojects, to generate a file for each project.

Requirements

The plugin has been tested with Gradle 8.3. The published jar is built with Java 17.

Current status

The plugin has not been published yet. To test it, clone the repository, publish the plugin to mavenLocal, and load it from there (follow these instructions).

leinardi / flatpak-gradle-generator Goto Github PK