https://github.com/britter/maven-plugin-development

Gradle plugin for building Apache Maven plugins
https://github.com/britter/maven-plugin-development

gradle-plugin maven

Last synced: 5 days ago
JSON representation

Gradle plugin for building Apache Maven plugins

• Host: GitHub
• URL: https://github.com/britter/maven-plugin-development
• Owner: britter
• License: apache-2.0
• Created: 2020-03-22T11:20:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T05:55:59.000Z (8 days ago)
• Last Synced: 2024-10-31T20:04:11.568Z (5 days ago)
• Topics: gradle-plugin, maven
• Language: Groovy
• Homepage: https://plugins.gradle.org/plugin/de.benediktritter.maven-plugin-development
• Size: 853 KB
• Stars: 29
• Watchers: 3
• Forks: 6
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Maven Plugin Development Gradle Plugin

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fbritter%2Fmaven-plugin-development%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/britter/maven-plugin-development/goto?ref=main)

[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v?label=Plugin%20Portal&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fde%2Fbenediktritter%2Fmaven-plugin-development%2Fde.benediktritter.maven-plugin-development.gradle.plugin%2Fmaven-metadata.xml)](https://plugins.gradle.org/plugin/de.benediktritter.maven-plugin-development)

This plugin aims to fill the tiny gap for people who need to create an [Apache Maven](https://maven.apache.org) plugin from a Gradle build.

To do this the plugin wraps around the [Maven Plugin Tools API](https://maven.apache.org/plugin-tools/) and feeds it with the right inputs from the Gradle build.

Compatible with Gradle 5.5.1 or later.

## Features

- Automatic generation of a maven plugin descriptor containing all mojos in the selected source set (by default the plugin looks for mojo implementations in the main source set)

- Support for annotation and JavaDoc tag based mojo implementations

- Optional generation of a help mojo implementation

## Usage

Please see the [plugin documentation](https://britter.github.io/maven-plugin-development).

For a self-contained example please the [example folder](https://github.com/britter/maven-plugin-development/tree/main/sample).

## How to release

- Pull latest changes

- Set the version to be released in `gradle.properties`

- Set the release date for the version to be released in `release-history.adoc`

- Commit and tag the change

- Run `./gradlew release -Prelease`

- Update the version in `gradle.properties` to the next development version

- Update the version in `sample/gradle-producer-build/build.gradle.kts` to the released version

- Commit the change

- Push changes and release tag

## Contribution policy

Contributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please state that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.

## License

This code is open source software licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.html).