Page History

Document Properties Marker

override	false

Short Description

Gradle Plugin Concept and Development

Doctype

architecture-aspect

hide

Name

Gradle Plugin Concept and Development

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
property	Audience

Tags

Tag List

property	Tags

Iteration


value	facadefilled

Sort Key

000200

hide

Section

title	Description

You should definitely read the original [Gradle User Guide] on custom plugin development.

To enable the required Gradle integration, we implement a lean wrapper as described in the Gradle user guide.

Code Block

language	groovy

class HtmlSanityCheckPlugin implements Plugin<Project> {
  void apply(Project project) {
    project.task('htmlSanityCheck',
            type: HtmlSanityCheckTask,
            group: 'Check')
  }
}

Content Marker

id	Content

Section

title	Directory Structure and Required Files

Code Block

language	text

|-htmlSanityCheck
   |  |-src
   |  |  |-main
   |  |  |  |-org
   |  |  |  |  |-aim42
   |  |  |  |  |  |-htmlsanitycheck
   |  |  |  |  |  |  | ...
   |  |  |  |  |  |  |-HtmlSanityCheckPlugin.groovy (1)
   |  |  |  |  |  |  |-HtmlSanityCheckTask.groovy
   |  |  |  |-resources
   |  |  |  |  |-META-INF                           (2)                     
   |  |  |  |  |  |-gradle-plugins
   |  |  |  |  |  |  |-htmlSanityCheck.properties   (3)
   |  |  |-test
   |  |  |  |-org
   |  |  |  |  |-aim42
   |  |  |  |  |  |-htmlsanitycheck
   |  |  |  |  |  |  | ...
   |  |  |  |  |  |  |-HtmlSanityCheckPluginTest
   |

the actual plugin code: HtmlSanityCheckPlugin and HtmlSanityCheckTask groovy files
Gradle expects plugin properties in META-INF
Property file containing the name of the actual implementation class:

Section

title	Passing Parameters From Buildfile to Plugin

To be done

Section

title	Building the Plugin

The plugin code itself is built with Gradle.

Section

title	Uploading to Public Archives

To be done

Section

title	Further Information on Creating Gradle Plugins

Although writing plugins is described in the Gradle user guide, a clearly explained sample is given in a Code4Reference tutorial.

Section

title	Motivation

Section

level	2
title	Quality Scenarios

Display Table

doctype	quality-scenario
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
empty-as-none	true

Section

level	2
title	Use Cases

Display Table

doctype	use-case
render-no-hits-as-blank	true
select	Name, Short Description	sort-by	Sort Key, Name
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

title	Solution

Section

level	2
title	Constraints

Display Table

sort-by

doctype	project-constraint
render-no-hits-as-blank	true
select	Name, Short Description	Sort Key, Name
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

level	2
title	Decisions

Display Table

doctype	architecture-decision
render-no-hits-as-blank	true
select	Name, Short Description	sort-by	Sort Key, Name
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

title	Application

Section

title	Discussion

Section

title	Subordinate Aspects

Display Table

sort-by

doctype	architecture-aspect
render-no-hits-as-blank	true
select	Name, Short Description	Sort Key, Name
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

required-permissions	write-access
title	Notes

...

Space shortcuts

Child pages

Versions Compared

Old Version 3

New Version Current

Key