Skip to content

mojohaus/versions

Repository files navigation

MojoHaus Versions Maven Plugin

This is the versions-maven-plugin.

Apache License, Version 2.0, January 2004 Maven Central Build Status

Maintained versions

Versions Maven Plugin requires Maven 3.6.3+ and JDK 1.8+.

However, we maintain the latest plugin version alongside the latest Maven release.

We execute tests against different operating systems and JDKs by GitHub Actions

Contributing

Creating Issues

If you find a problem, please first search the current open and closed issues and pull requests. Someone may have already reported a similar issue.

You can also check the current milestone to see what will be in the next release.

Only if you cannot find a similar issue, please create a new one in the ticket system and describe what is going wrong or what you expect to happen.

If you have a full working example or a log file, this is also helpful.

Describe only a single issue per ticket; do not mix several issues into one.

Please always check your issue with the latest Plugin and the latest Maven version.

Creating a Pull Request

Before working on a more complicated change or new feature, it is good practice to create an issue in the ticket system or send an email to development list and describe what the problem is or what kind of feature you would like to add. Wait a few days for feedback from other contributors. Afterwards you can create an appropriate pull request.

To have a pull request integrated, please squash your commits into a single commit that references the issue in the commit message, for example:

Fixed #Issue - change subject

a description

Note that the commit subject will be used in release notes and preserved in Git history, so it should be sufficiently descriptive.

This simplifies merging and automatically closes the related issue. It also makes life as a maintainer a little easier.

A pull request must address only a single ticket and should never create, add, or fix several issues at once, as otherwise the history is hard to read and maintenance of issues and pull requests becomes very difficult.

Releasing

  • Make sure gpg-agent is running.
  • Execute mvn -B release:prepare release:perform

For publishing the site do the following:

cd target/checkout
mvn site
mvn scm-publish:publish-scm

For a multi-module site, two executions are needed.