Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/micronaut-projects/micronaut-maven-plugin

Maven plugin to execute Micronaut applications
https://github.com/micronaut-projects/micronaut-maven-plugin

groovy java kotlin maven micronaut

Last synced: 6 days ago
JSON representation

Maven plugin to execute Micronaut applications

Host: GitHub
URL: https://github.com/micronaut-projects/micronaut-maven-plugin
Owner: micronaut-projects
License: apache-2.0
Created: 2020-03-31T10:02:30.000Z (almost 5 years ago)
Default Branch: 4.7.x
Last Pushed: 2024-10-29T09:29:21.000Z (2 months ago)
Last Synced: 2024-10-29T09:50:12.514Z (2 months ago)
Topics: groovy, java, kotlin, maven, micronaut
Language: Java
Homepage: https://micronaut-projects.github.io/micronaut-maven-plugin/latest/
Size: 26 MB
Stars: 21
Watchers: 17
Forks: 21
Open Issues: 36
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Micronaut Maven Plugin

[![Maven Central](https://img.shields.io/maven-central/v/io.micronaut.maven/micronaut-maven-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/io.micronaut.maven/micronaut-maven-plugin)
[![Build Status](https://github.com/micronaut-projects/micronaut-maven-plugin/actions/workflows/snapshot.yml/badge.svg)](https://github.com/micronaut-projects/micronaut-maven-plugin/actions)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=io.micronaut.maven%3Amicronaut-maven-plugin-parent&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=io.micronaut.maven%3Amicronaut-maven-plugin-parent)
[![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.micronaut.io/scans)

Maven plugin to execute Micronaut applications.

## Documentation

See the [Documentation](https://micronaut-projects.github.io/micronaut-maven-plugin/latest) for more information.

See the [Snapshot Documentation](https://micronaut-projects.github.io/micronaut-maven-plugin/snapshot) for the current development docs.

To see the documentation of a particular version, replace `latest` or `snapshot` in the above URLs with the version string.

## Snapshots and Releases

Snaphots and releases are automatically published to Maven Central using [GitHub Actions](https://github.com/micronaut-projects/micronaut-maven-plugin/actions).

A release is performed with the following steps:

* [Publish the draft release](https://github.com/micronaut-projects/micronaut-maven-plugin/releases). There should be already a draft release created, edit and publish it. The Git Tag should start with `v`. For example `v1.0.0`.
* [Monitor the Workflow](https://github.com/micronaut-projects/micronaut-maven-plugin/actions?query=workflow%3ARelease) to check it passed successfully.
* Celebrate!

## Contributing tips and tricks

### Running integration tests

You can run integration tests by executing `mvn verify`

If you want to run individual tests, you can execute `mvn verify "-Dinvoker.test=dockerfile*"`. In this case,
`dockerfile*` will match all test projects under `src/it` folder with a name that starts with "dockerfile".

### Debugging

To debug the plugin, you first need to publish a snapshot to your Maven local:

```shell
$ mvn install
```

You can skip execution of integration tests by adding `-Dinvoker.skip=true` to the command line.

Then you need a sample application. The one at `examples/java` is the most up-to-date, but you can in principle generate
a new one from Micronaut Starter. Then, change its `pom.xml` to set the following property:

```xml
1.1.5-SNAPSHOT
```

Pointing to whatever snapshot version you published before.

Finally, from the sample application folder, run the Maven goal you are interested into with `mvnDebug` instead of `mvn`:

```shell
mvnDebug package -Dpackaging=docker
```

Then in your IDE, attach a remote debugger to port 8000.

### Preparing for a new minor/major version

```shell
mvn release:update-versions -DautoVersionSubmodules=true -DdevelopmentVersion=4.6.0-SNAPSHOT
```