Code Monkey home page Code Monkey logo

maven-vault-checkout-plugin's Introduction

Cognifide logo

Maven Vault Checkout Plugin

Purpose

This is a plugin designed for Maven 2.x+ based builds to automate content checkout process. It allows to set up content checkout, and remove some unnecessary properties from .content.xml files.

Features

  • downloads content(using vlt) from CQ/AEM instance
  • removes .vlt files
  • removes properties from .content.xml files

Prerequisites

  • Maven 2.x, 3.x

Installation

Checkout the source code:

cd [folder of your choice]
git clone git://github.com/Cognifide/Maven-Vault-Checkout-Plugin.git
cd Maven-Vault-Checkout-Plugin

Compile and install:

mvn clean install

Usage

Set up POM file:

    (...)
    <plugin>
        <groupId>com.cognifide.maven.plugins</groupId>
        <artifactId>vltco-maven-plugin</artifactId>
        <version>0.2.0</version>
        <configuration>
            <uri>http://localhost:4503</uri>
            <user>author</user>
            <password>author</password>
            <localPath>src/main/content/jcr_root</localPath>
            <filter>src/main/content/jcr_root</filter>
            <!-- custom content properties that will be removed from .content.xml during clean goal -->
            <contentProperties>
                <contentProperty>my:contentProperty</contentProperty>
            </contentProperties>
        </configuration>
    </plugin>
    (...)

Now you can invoke one of the Maven Vault Checkout Plugin goals:

  • to checkout content from instance use

      mvn vltco:checkout
    
  • to remove .vlt files and cleans content.xml from unnecessary properties use (default properties are: jcr:uuid, jcr:lastModified, jcr:lastModifiedBy, jcr:created, jcr:createdBy, cq:lastModified, cq:lastModifiedBy, cq:lastReplicated, cq:lastReplicatedBy, cq:lastReplicationAction, cq:lastReplicationStatus)

      mvn vltco:clean
    
  • to checkout and remove .vlt files and cleans content.xml from unnecessary properties use

      mvn vltco:clean-checkout
    

Configuration

Maven Vault Checkout Plugin can be configured using element (see Usage sample above) with following tags:

Parameter name Default value Description
uri http://localhost:4502 instance uri
user admin user name
password admin user password
localPath src/main/aem/jcr_root directory for the content to be stored in
filter src/main/aem/META-INF/vault/filter.xml filter file location
contentProperties jcr:uuid, jcr:lastModified, jcr:lastModifiedBy, jcr:created, jcr:createdBy, cq:lastModified, cq:lastModifiedBy, cq:lastReplicated, cq:lastReplicatedBy, cq:lastReplicationAction, cq:lastReplicationStatus list of properties that will be remove from .content.xml files during clean goal

Commercial Support

Technical support can be made available if needed. Please contact us for more details.

We can:

  • prioritize your feature request,
  • tailor the product to your needs,
  • provide a training for your engineers,
  • support your development teams.

maven-vault-checkout-plugin's People

Contributors

dprzybyl avatar lmatyja avatar wiiitek avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.