build

How To Utilize Plugins

Purpose

The Purpose of this plugin is to make it easier to release to complicated repositories such as GCP and GitHub.

This plugin intentionally excludes the default assigned plugin artifact, so you can custom add custom names for the plugins.

If you’d like to include the default assigned plugin artifact, use io.github.pacificengine.build.release instead.

Example Projects

• io.github.pacificengine.build.docker
• io.github.pacificengine.build.java
• io.github.pacificengine.build.plugin.groovy
• io.github.pacificengine.build.plugin.release
• io.github.pacificengine.build.release
• io.github.pacificengine.build.repository
• io.github.pacificengine.build.zip

Usage

Just include the plugin into any build you’d like to use it in and assign the appropriate properties.

Gradle File

plugins {
    id 'io.github.pacificengine.build.plugin.groovy' version '0.1.0'
    id 'io.github.pacificengine.build.plugin.release' version '0.1.0'
    id 'com.gradle.plugin-publish' version "1.2.1"
}

Properties

Required Properties

• project.group The group the archive belongs to (Example: io.github.PacificEngine)
• project.name The name of the project (Should be automatically assigned by gradle) (Example: zipper)
• project.version The build version of the project (Example: 1.0.0)

Optional Properties

• project.sign To determine if the release should be signed (Defaults to only on non-SNAPSHOT builds, true will always sign, false will never sign)
• plugin.artifact.group The group to assign the plugin artifact in maven (Defaults to plugin.id otherwise project.archive.group otherwise project.group)
• plugin.artifact.id The artifact id to assign the plugin artifact in maven (Defaults to ${plugin.id}.gradle.plugin otherwise project.archive.name otherwise ${rootProject.name}-${project.name})
• plugin.artifact.version The version id to assign the plugin artifact in maven (Defaults to project.version)

Git Maven

• git.maven.repo.url The maven repo for the git project you want to push the release to
• git.maven.url Utilized if git.maven.repo.url is not defined. It is the base url for git maven commits (Defaults to System Variable GIT_MAVEN_URL)
• git.project.name Utilized if git.maven.repo.url is not defined. The project name of the git project you want to push the release into (Defaults to project.name.short)``
• git.maven.repo.user The git username (Defaults to System Variable GIT_USERNAME)
• git.maven.repo.key The git key (Defaults to git.repo.key otherwise to System Variable GIT_TOKEN)

GCP Maven

• gcp.maven.repo.url The GCP artifactory repository to release to (Defaults to System Variable GCP_MAVEN_URL)
• gcp.maven.repo.user The GCP username (Defaults to System Variable GCP_MAVEN_USER)
• gcp.maven.repo.key The GCP key (Defaults to System Variable GCP_MAVEN_KEY)

This site is open source. Improve this page.