Skip to content

maven: A new Maven plugin for generating manifests and more for Java projects #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
brett-smith wants to merge 1 commit into from
Closed

maven: A new Maven plugin for generating manifests and more for Java projects #505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions maven/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Flatpak Maven (Java) Generator

Generate a Flatpak manifest and other required files from a Maven POM to create a distributable application. For the most part, the plugin follows Mavens "Convention Over Configuration" approach, meaning you can go from source to a distributable application with the minimum amount of effort. However it is also highly configurable, allowing any generated meta-data or resources to be overridden.

The plugin will generate a manfest with all required dependencies for the simple build system, AppStream metadata, desktop entries and a launcher script using as much information as it can derive from your POM. The more complete your POM, the less additional information you may need to add to meet Flatpaks requirements.

See [flatpak-maven-plugin](https://github.com/bithatch/maven-flatpak-plugin) for more information.

## Requirements

* Apache Maven (recommended 3.9+).
* Java 8 or above.
* A Java Maven project with a `pom.xml`.
* `flatpak-builder` is optional for `build` goal.

That's it. The plugin is available on Maven Central and will be automatically downloaded when included in your POM.

*The directory containing this README.md isn't required in your project like it might be with our languages and build systems.*

## Usage

Add the plugin to your POM. It is recommended you [check Maven Central](https://central.sonatype.com/artifact/uk.co.bithatch/flatpak-maven-plugin) for the latest version number.

```xml
<plugin>
<groupId>uk.co.bithatch</groupId>
<artifactId>flatpak-maven-plugin</artifactId>
<version>0.0.4</version>
<configuration>
<mainClass>com.acme.Abc</mainClass>
</configuration>
</plugin>
```

Then run ...

```
mvn clean package uk.co.bithatch:maven-flatpak-plugin:generate
```

This will by default generate the Flatpak manifest and others in `target/app`. So from here you can build the package.

```
cd target/app
flatpak-builder build-dir com.acme.Abc.yml
```

And then test and run.

```
flatpak-builder --user --install --force-clean build-dir com.acme.Abc.yml
flatpak run com.acme.Abc
```

See plugin [project page](https://github.com/bithatch/maven-flatpak-plugin) for more complete examples.