TWCable / cq-gradle-plugin

DEPRECATED: A number of plugins for making it easier to work with Gradle and Adobe CQ/AEM

DEPRECATED

This project has been split apart and active development has moved to:

• TWCable/gradle-plugin-cq-package
• TWCable/gradle-plugin-cq-bundle
• TWCable/gradle-plugin-scr
• TWCable/gradle-plugin-bundlor

Purpose

This contains a number of plugins for making it easier to work with Gradle and Adobe CQ/AEM.

Installation

buildscript {
    repositories {
        jcenter()
        maven {
            url "http://dl.bintray.com/twcable/aem"
        }
    }

    dependencies {
        classpath "com.twcable.gradle:cq-gradle-plugins:3.0.2"
    }
}

Built against Gradle 2.2.1

Plugins

CQ Package Plugin

See the CQ Package Plugin documentation

SCR Plugin

Usage

apply plugin: 'scr'

Applying the plugin implicitly applies the osgi plugin and adds a dependency from the jar task upon processScrAnnotations.

Tasks

• processScrAnnotations - Processes the x-doclet style and @SCR annotations to create the appropriate OSGi metadata for OSGi Declarative Services.

Sling Bundle Plugin

Usage

apply plugin: 'sling-bundle'

Tasks

• uploadBundle - Uploads the bundle to the CQ server. The task will fail if the bundle fails to start.
• deleteBundle - Removes the current bundle from CQ. This task will not fail if the bundle does not exist.
• refreshAllBundles - Tells CQ to refresh all the bundles. This gets added to the top-level project and generally a good idea to run after any of the other tasks.
• showBundle - Shows a JSON representation of the information CQ has about the bundle, including its status, what bundles it is using, and what bundles are using it to STDOUT.

Configuration

Convention: slingServers

Creates the slingServers convention object. See the "CQ Package Plugin" for details.

Convention: bundle

By default, the plugin is initialized with the following effective configuration:

bundle.with {
  name = project.name
  symbolicName = // computed from project.group and project.name
  installPath = project.slingServers.author.installPath
  sourceFile = project.jar.archivePath
  slingServers = project.slingServers
}

bundle also has a felixId property that the plugin tries to determine dynamically from the server based on the bundle's symbolic name.

LICENSE

Copyright 2015 Time Warner Cable, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.