Plugin generates common github links (like repository, issues, vcs etc) for project and configures common plugins. The main intention is to remove boilerplate and simplify project configuration.

Features:

• Supports plugins:
  • maven-publish configure published pom sections (including license section)
  • plugin-publish configure gradle plugin links
• Conventional github links may be used directly to configure other plugins manually through github object (e.g. github.site)
• In multi-module project always configures defaults from the root project

You can use it with java-lib plugin to remove more configuration boilerplate for java or groovy library or gradle plugin.

• Configuration closures: github

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath 'ru.vyarus:gradle-github-info-plugin:2.0.0'
    }
}
apply plugin: 'ru.vyarus.github-info'

OR

plugins {
    id 'ru.vyarus.github-info' version '2.0.0'
}

Plugin compiled for java 8, compatible with java 17

Minimum required configuration:

github {
    user 'test'
    license 'MIT'    
}

User may be used to define either user or organization (links will be correct for both). github.repository will be set to project name by default (root project name in case of multi-module).

Other license properties may be also required (see below).

All other properties are generated by conventions. You can override any property.

If some required properties are not set validation error will be thrown to prevent incorrect usage.

All properties may be used in other configurations

github {
    user 'test'
    license 'MIT'
}

somePlugin {
    websiteUrl = github.site
    vcsUrl = github.vcsUrl
    importantFileUrl = github.rawFileUrl('IFile.txt')
}

Plugin contains hardcoded info for most common licenses:

If license property value is one of license id above then licenseName will be set. Otherwise, licenseName must be specified manually.

licenseUrl default:

• Looks if LICENSE or LICENSE.txt file contained in project root, then url will be https://raw.githubusercontent.com/$user/$repository/HEAD/LICENSE (or with txt extension accordingly)
• If license file not found in project, but license matches known license id (table above) then url will be set as link to opensource.org (see links above)
• If neither license file found nor license id recognized then url must be set manually

github.rawFileUrl(file, branch) method may be used in build script to generate direct (raw) urls to files on github repository.

For example,

github.rawFileUrl('folder/file.txt')

Will generate the following url:

https://raw.githubusercontent.com/$user/$repository/HEAD/folder/file.txt

Branch parameter is optional ('HEAD' by default in order to support both old 'master' and new 'main' default branch names)

Plugin recognize some common plugins and apply default values to them (but not overrides user configuration!)

If maven-publish plugin available, then for all defined publications pom will be extended with:

<url>${github.site}</url>
<scm>
    <url>${github.vcsUrl}</url>
    <connection>${github.scmConnection}</connection>
    <developerConnection>${github.scmConnection}</developerConnection>
</scm>
<licenses>
    <license>
        <name>${github.licenseName}</name>
        <url>%{github.licenseUrl}</url>
        <distribution>repo</distribution>
    </license>
</licenses>
<issueManagement>
    <system>GitHub</system>
    <url>${github.issues}</url>
</issueManagement>

If publish-plugin plugin available, then following defaults will be applied for gradle 7.6 and above:

gradlePlugin {
    website = github.site
    vcsUrl = github.vcsUrl
}

For older gradle versions pluginBundle configured:

pluginBundle {
    website = github.site
    vcsUrl = github.vcsUrl
}

So you can avoid these properties in gradlePlugin configuration in your build file. If you manually specify any of these values it will not be overridden.

• quality-plugin - java and groovy source quality checks
• pom-plugin - improves pom generation
• java-library generator - java library project generator