WarpFleet-Gradle-Plugin

Installation

apply plugin: 'io.warp10.warpfleet-gradle-plugin'
 
buildscript{
  repositories {
      mavenCentral()
      mavenLocal()
 
      dependencies{
        classpath 'io.warp10:warpfleet-gradle-plugin:1.0-SNAPSHOT'
      }
  }
}

Usage

In a build.gradle

apply plugin: 'io.warp10.warpfleet-gradle-plugin'
 
buildscript{
  repositories {
      mavenCentral()
      mavenLocal() 
      dependencies{
        classpath 'io.warp10:warpfleet-gradle-plugin:0.0.3'
      }
  }  
}

warpfleet {
    url = "https://sandbox.senx.io/api/v0/exec" 
    source = "/opt/tmp" 
    dest = "./doc" 
    macroDir = "doc"
    format = "json"
}

Available tasks

$ ./gradlew -q tasks --group WarpFleet

...

WarpFleet tasks
---------------
wfDoc - Generates documentation files against a Warp 10 instance thanks to the INFOMODE.
wfGetArtifactInfo - Get Artifact info
wfGetArtifacts - Get list of available artifacts
wfGetGroups - Get list of available groups
wfGetVersions - Get list of available artifact's versions
wfInstall - Install Artifact
wfPublish - Publishes a plugin, macro or extension against WarpFleet
wfUnPublish - Unpublishes a plugin, macro or extension against WarpFleet

...

wfGetGroups - Get list of available groups

$ ./gradlew -q wfGetGroups 
- io.senx
- io.warp10
...

wfGetArtifacts - Get list of available artifacts

$ ./gradlew -q wfGetArtifacts --group=io.warp10
- io.warp10:warp10-ext-arrow:2.0.3-uberjar (Conversions to and from Apache Arrow streaming format)
- io.warp10:warp10-ext-barcode:1.0.2-uberjar (WarpScript™ Barcode Extension)
- io.warp10:warp10-ext-flows:0.1.1-uberjar (FLoWS WarpScript Extension)
- io.warp10:warp10-ext-forecasting:2.0.0 (Forecast extension)
- io.warp10:warp10-ext-geotransform:0.2.3-uberjar (Extension to transform coordinates from one geographic coordinate system to another. Based on Proj4J.)
- io.warp10:warp10-ext-git:1.0.1-uberjar (WarpScript Git Extension)
...

wfGetVersions - Get list of available artifact's versions

$ ./gradlew -q wfGetVersions --group=io.warp10 --artifact=warp10-plugin-warpstudio
- Name:            io.warp10:warp10-plugin-warpstudio
- Description:     WarpStudio, the WarpScript editor
- Latest version:  2.0.6
- Available:
    - 2.0.6
    - 2.0.5
    - 2.0.4
    - 2.0.3
    - 2.0.2

wfGetArtifactInfo - Get Artifact info

$ ./gradlew -q wfGetArtifactInfo --group=io.warp10 --artifact=warp10-plugin-warpstudio --vers=2.0.3
- io.warp10:warp10-plugin-warpstudio:2.0.3 (WarpStudio, the WarpScript editor)

wfInstall - Install Artifact

Single Artifact installation

$ ./gradlew -q wfInstall --group=io.warp10 --artifact=warp10-plugin-warpstudio --vers=2.0.3 --dest=/opt/warp10
$ ./gradlew -q wfInstall --group=io.warp10 --artifact=warp10-plugin-warpstudio --vers=latest --dest=/opt/warp10
$ ./gradlew -q wfInstall --group=io.warp10 --artifact=warp10-plugin-warpstudio --dest=/opt/warp10

With the packages syntax

$ ./gradlew -q wfInstall --packages=io.warp10:warp10-plugin-warpstudio:2.0.3:jar --dest=/opt/warp10
$ ./gradlew -q wfInstall --packages=io.warp10:warp10-plugin-warpstudio:2.0.3 --dest=/opt/warp10
$ ./gradlew -q wfInstall --packages=io.warp10:warp10-plugin-warpstudio:latest --dest=/opt/warp10
$ ./gradlew -q wfInstall --packages=io.warp10:warp10-plugin-warpstudio --dest=/opt/warp10

Multiple artifacts

$ ./gradlew -q wfInstall \
    --packages=io.warp10:warp10-plugin-warpstudio:latest,io.warp10:warp10-ext-barcode \
    --dest=/opt/warp10

wfDoc - Generate documentation

For instance for @path/to/macro and /path/to/root/folder/path/to/macro.mc2

Output format:

• default: json
• json: JSON files
• md or markdown: Markdown files with an index
• html: HTML pages with an index.
• pdf: PDF files generation, one page per macro in a single file

You should use:

./gradlew -q wfDoc \
    --url=https://warp10.server/api/v0/exec \ 
    --source=/path/to/root/folder \             # where your Warpscripts are located  
    --dest=./doc \                              # documentation destination
    --macroDir=path \                           # root path of your macros
    --format=json                               # json by default (could be html, pdf or md)

wfPublish - Publish an artifact against WarpFleet

./gradlew -q wfPublish \
    --gpgKeyId=BDxxx0A \                        # Optional GPG Key Id
    --vers=1.2.3                                # Optional version overrides version in wf.json
    --wfJson=/path/to/wf.json                   # where wf.json is located

wfUnPublish - UnPublish an artifact against WarpFleet

./gradlew -q wfUnPublish \
    --gpgKeyId=BDxxx0A \                        # Optional GPG Key Id
    --vers=1.2.3                                # Optional version overrides version in wf.json
    --wfJson=/path/to/wf.json                   # where wf.json is located