https://github.com/walkmod/gradle-walkmod-plugin

A Gradle plugin to easily integrate Walkmod on your projects
https://github.com/walkmod/gradle-walkmod-plugin

Last synced: 5 months ago
JSON representation

A Gradle plugin to easily integrate Walkmod on your projects

• Host: GitHub
• URL: https://github.com/walkmod/gradle-walkmod-plugin
• Owner: walkmod
• License: apache-2.0
• Fork: true (rpau/gradle-walkmod-plugin)
• Created: 2016-02-22T13:01:19.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-02-18T20:30:58.000Z (over 7 years ago)
• Last Synced: 2024-04-16T20:18:47.238Z (about 2 years ago)
• Language: Groovy
• Size: 212 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
= Walkmod Gradle Plugin

Abel Salgado Romero

=======

:version: 0.0.1

:walkmod-url: http://www.walkmod.com/

:issues: https://github.com/abelsromero/gradle-walkmod-plugin/issues

:gradle-url: http://gradle.org/

:maven-gradle-plugin: https://github.com/rpau/maven-walkmod-plugin

:project-name: gradle-walkmod-plugin

:walkmod-cmd: walkmod-cmd:3.0.0

:ivy-url: http://ant.apache.org/ivy/

image:http://img.shields.io/travis/abelsromero/{project-name}/master.svg["Build Status", link="https://travis-ci.org/abelsromero/{project-name}"]

image:http://img.shields.io/coveralls/abelsromero/{project-name}/master.svg["Coverage Status", link="https://coveralls.io/r/abelsromero/{project-name}"]

image:http://img.shields.io/:semver-{version}-blue.svg["Semantic Versioning", link="http://semver.org"]

The {doctitle} is the first tool to provide {walkmod-url}[Walkmod] integration with {gradle-url}[Gradle].

This plugin adds two new tasks to allow checking and applying walkmod changes to your projects.

WARNING: this is a preliminary version and still some work must be done.

== Installation

As long as this is a preliminary version, no fixed repository exists. If you wish to test the tool, you'll need to install it locally from sources.

A `install` task is provided to simplify the installation in maven local.

Use the following snippet inside a Gradle build file:

.build.gradle

[source,groovy]

[subs="attributes"]

----

buildscript {

    repositories {

       mavenCentral()

       jcenter()

    }

    dependencies {

        classpath 'org.walkmod:gradle-walkmod-plugin:{version}'

    }

    walkmod {

      chains = ['pmd']

    }

}

apply plugin: 'walkmod'

----

== Usage

The plugin adds a three new tasks:

. `walkmodCheck`: checks for possible changes. Same as using `walkmod check` in the command tool.

. `walkmodApply`: applies changes. Same as using `walkmod apply` in the command tool.

. `walkmodPatch`: generates a patch. Same as using `walkmod patch` in the command tool.

=== Properties

Each tasks provides the following properties for its configuration:

[horizontal]

chains:: chain names to check or apply. Type: List. Default: `empty` (all chains).

offline:: `true` to resolve dependencies (uses {ivy-url}[Ivy]), `false` to resolve locally. Type: `boolean`. Default: `false`.

verbose:: `true` to show extra information. Type: `boolean`. Default: `false`.

showErrors:: `true` to get full details when something goes wrong. Type: `boolean`. Default: `false`.

properties:: dynamic parameters for the execution. Type: String

config:: walkmod configuration file (e.g walkmod.xml). Default: `` (empty).

=== Methods

None right now (this may change in the future).

== Contributing

In the spirit of free and open software, _everyone_ is encouraged to help improve this project.

If you discover errors or omissions in the source code, documentation, please don't hesitate to submit an issue or open a pull request with a fix.

New contributors are always welcome!

Here are some ways *you* can contribute:

* by using prerelease (alpha, beta or preview) versions

* by reporting bugs

* by suggesting new features

* by writing or editing documentation

* by writing specifications

* by writing code -- _No patch is too small._

** fix typos

** add comments

** clean up inconsistent whitespace

** write tests!

* by refactoring code

* by fixing {uri-issues}[issues]

* by reviewing patches