About

The modular assertion builder is a gradle plugin that can be used to build modular assertions for the CA API Gateway

Usage

The latest published artifact version on Maven Central is 0.5.1, built with Gradle 4.10.2. For new builds, build and publish the plugin to your own plugin repository.

Branching Strategy

The naming convention of our branches corresponds to the compatible Gradle version. For instance, the 7.x branch corresponds to the branch compatible with Gradle 7.x.

Gradle Configuration

In order to use this plugin to build a modular assertion add the following you your gradle file:

plugins {
    id "com.ca.apim.gateway.modular-assertion-builder" version "<version>"
}

group 'com.ca'
version '<assertion-version>'

repositories {
    maven {
        url "<repository-url>"
    }
}

modularAssertionBuilder {
    gatewayBaseVersion = '<gateway-version>'
    assertionName='My-Modular-Assertion'
    revision='<source code revision id>' // optional property to id the source commit, e.g. git commit hash / svn revision number
}

dependencies {
    // These are libraries that are required to be packaged in the Modular Assertion
    releaseJars(
    )
}

Building the Plugin

The build is done using gradle. The following targets are exposed:

clean

This removes the build directory.

build

This target builds the Modular Assertion Builder. Once built it is available in the build/libs directory. This target uses the version property to set the version in the package file name.

publish

This target publishes the built package to artifact repository.

The following properties are used in the publish target:

Property	Description
mavenUser	This is the name of the artifactory user to authenticate with
mavenPassword	This is the password of the artifactory user to authenticate with
mavenUrl	This is the artifact repository url to publish to.

publish to local

You can also publish the modular assertion builder to your local maven repository by running: gradle install

How You Can Contribute

Contributions are welcome and much appreciated. To learn more, see the Contribution Guidelines.

License

Copyright © 2017-2024. Broadcom Inc. and its subsidiaries. All Rights Reserved.

This software may be modified and distributed under the terms of the MIT license. See the LICENSE file for details.