search

TWCable / gradle-plugin-scr

Makes it easier to work for with the Felix SCR annotations for Gradle
Apache License 2.0
4 stars 2 forks source link

readme

Purpose

This makes it easier to work for with the Felix SCR annotations for Gradle and Apache Felix (including Adobe CQ/AEM).

Download Build Status

Usage

apply plugin: 'com.twcable.scr'

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

Task

processScrAnnotations - Processes the @SCR annotations to create the appropriate OSGi metadata for OSGi Declarative Services.

By default it will also verify that every @Reference is to an interface, and fails the build if it is trying to link to a class. This safety check can be disabled if needed by setting the skipInterfaceReferenceCheck property to true on this task.

Installation

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

    dependencies {
        classpath "com.twcable.gradle:gradle-plugin-scr:<version>"
    }
}

Built against Gradle 3.5 and JDK 1.8

API

https://twcable.github.io/gradle-plugin-scr/groovydoc/

LICENSE

Copyright 2014-2017 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.