Skip to content

codecentric/gradle-opencms-plugin

Repository files navigation

gradle-opencms-plugin

Build Status Coverage Status License

The gradle-opencms-plugin lets you build OpenCMS modules using gradle.

Usage

Use the cms_scaffold task to create required files and meta data files.

Use the cms_deploy task to create a OpenCMS module, that can than be deployed to an OpenCMS instance.

Minimal configuration example

opencms {
    webInf = "${project.opencms_dir}/WEB-INF"
    username = "Admin"
    password = "admin"
    cmsProject = "Offline"
    cmsVersion = "9.0.1"
    module {
        name = "de.codecentric.cms.test"
        group = "codecentric"
        nicename = "OpenCms Testprojekt"
        description = "A project to demonstrate usage of the OpenCms plugin."
        author = "Codecentric AG"
        email = "[email protected]"
        version = "0.0.1"
        actionClass = ""
        feature {
            type = "myFeature"
            name = "myFeature"
            nicename = "Brilliant Testfeature"
            listname = "Default myFeature Formatter"
            description = "A brilliant test feature!"
        }
        
        // may contain several features
        
        exportpoint(uri: 'lib/', destination: 'WEB-INF/lib/')
        exportpoint(uri: 'classes/', destination: 'WEB-INF/classes/')
        exportpoint(uri: 'system/', destination: 'WEB-INF/')
        resource(uri: '')
    }
}

License

Code is under the Apache Licence v2.