github-release-plugin

Maven plugin to create github releases and upload assets to the release

License	The Apache License, Version 2.0
Categories	Github Development Tools Version Controls
GroupId	de.jutzig
ArtifactId	github-release-plugin
Last Version	1.4.0
Release Date	Oct 4, 2019
Type	maven-plugin
Description	github-release-plugin Maven plugin to create github releases and upload assets to the release
Project URL	https://github.com/jutzig/github-release-plugin
Source Code Management	https://github.com/jutzig/github-release-plugin

Download github-release-plugin

Filename	Size
github-release-plugin-1.4.0.pom
github-release-plugin-1.4.0.jar	11 KB
github-release-plugin-1.4.0-sources.jar	7 KB
github-release-plugin-1.4.0-javadoc.jar	24 KB

How to add to project

Apache Maven

<plugin>
    <groupId>de.jutzig</groupId>
    <artifactId>github-release-plugin</artifactId>
    <version>1.4.0</version>
</plugin>

Dependencies

compile (1)

Group / Artifact	Type	Version
org.kohsuke : github-api	jar	1.95

provided (3)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.6.2
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.6.0
org.apache.maven : maven-core	jar	3.5.4

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

github-release-plugin

uses the github release api to upload files

To use the plugin you need to configure it in your pom.xml like so

<plugin>
    <groupId>de.jutzig</groupId>
    <artifactId>github-release-plugin</artifactId>
    <version>1.1.1</version>
    <configuration>
        <description>Description of your release</description>
        <releaseName>1.0 Final</releaseName>
        <tag>${project.version}</tag>
        
        <!-- If your project has additional artifacts, such as ones produced by
             the maven-assembly-plugin, you can define the following
             (requires version 1.1.1 of the plugin or higher): -->
        <fileSets>
            <fileSet>
                <directory>${project.build.directory}</directory>
                <includes>
                    <include>${project.artifactId}*.tar.gz</include>
                    <include>${project.artifactId}*.zip</include>
                </includes>
            </fileSet>
        </fileSets>
    </configuration>
</plugin>

Unless otherwise specified, the plugin will upload the main artifact of your project and take the github repository url from the <scm> section.

By default, the plugin will look for your github credentials in your maven settings.xml. Example

<servers>
    <server>
        <id>github</id>
        <username>GITHUB_USERNAME</username>
        <password>GITHUB_PASSWORD</password>
    </server>
</servers>

These credentials can be overridden by setting username and password as system properties.

Thanks to a contribution from rowanseymour you can also use your API token by adding it as <privateKey> to your server definition in the settings.xml.

Additional Parameters:

• -Dgithub.draft=true creates the release in draft state
• -Dgithub.commitish=release/1.0.0 allows to specify a commitsh

The plugin is available on Maven central

Versions

Version
1.4.0 Oct 4, 2019
1.3.1 Oct 4, 2019
1.3.0 Nov 9, 2018
1.2.0 Jan 9, 2017
1.1.1 Apr 8, 2015
1.1.0 Oct 9, 2014