https://github.com/twcable/cq-gradle-plugin

DEPRECATED: A number of plugins for making it easier to work with Gradle and Adobe CQ/AEM
https://github.com/twcable/cq-gradle-plugin

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/twcable/cq-gradle-plugin
• Owner: TWCable
• License: apache-2.0
• Created: 2015-02-24T13:55:09.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-17T12:48:40.000Z (about 9 years ago)
• Last Synced: 2023-02-27T02:41:08.119Z (almost 2 years ago)
• Language: Groovy
• Homepage:
• Size: 1.5 MB
• Stars: 19
• Watchers: 13
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# DEPRECATED #

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

* [TWCable/gradle-plugin-cq-package](../../../gradle-plugin-cq-package)

* [TWCable/gradle-plugin-cq-bundle](../../../gradle-plugin-cq-bundle)

* [TWCable/gradle-plugin-scr](../../../gradle-plugin-scr)

* [TWCable/gradle-plugin-bundlor](../../../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**

[ ![Download](https://api.bintray.com/packages/twcable/aem/cq-gradle-plugins/images/download.svg) ](https://bintray.com/twcable/aem/cq-gradle-plugins/_latestVersion)

# Plugins #

## CQ Package Plugin ##

See [the CQ Package Plugin documentation](docs/CqPackagePlugin.adoc)

## 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.