mojohaus / keytool

Apache License 2.0
16 stars 13 forks source link

= MojoHaus Keytool Maven Plugin

This is the MojoHaus http://www.mojohaus.org/keytool/[keytool]. This repository also includes the https://www.mojohaus.org/keytool/keytool-maven-plugin/[keytool-maven-plugin].

image:https://img.shields.io/github/license/mojohaus/keytool.svg?label=License["Apache License, Version 2.0, January 2004",link=http://www.apache.org/licenses/] image:https://img.shields.io/maven-central/v/org.codehaus.mojo/keytool-maven-plugin.svg?label=Maven%20Central[Maven Central,link=https://search.maven.org/artifact/org.codehaus.mojo/keytool-maven-plugin] image:https://github.com/mojohaus/keytool/workflows/GitHub%20CI/badge.svg?branch=master[Build Status,link=https://github.com/mojohaus/keytool/actions/workflows/maven.yml?query=branch%3Amaster]

== Contributing

=== Creating Issues

If you find a problem please create an https://github.com/mojohaus/keytool/issues[issue in the ticket] 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. You should of course describe only a single issue in a single ticket and not mixing up several different things into a single issue.

=== Creating a Pull Request

Before you create a pull request it is necessary to create an issue in the https://github.com/mojohaus/keytool/issues[ticket system] and describe what the problem is or what kind of feature you would like to add. Afterwards you can create an appropriate pull request.

It is required if you want to get a Pull request to be integrated into please squash your commits into a single commit which references the issue in the commit message which looks like this:

[source,markdown]

Fixes #Issue

This makes it simpler to merge it and this will also close the appropriate issue automatically in one go. This make the life as maintainer a little easier.

A pull request has to fulfill only a single ticket and should never create/add/fix several issues in one, because otherwise the history is hard to read and to understand and makes the maintenance of the issues and pull request hard or to be honest impossible.

== Releasing

For publishing the site do the following:

[source,bash]

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