org.nuiton.jredmine.plugin.announcement.GenerateNewsAnnouncementMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-jredmine-plugin Show documentation

JRedmine maven plugin to interacts with Redmine's server

There is a newer version: 1.2.2

Show newest version

/*
 * #%L
 * JRedmine :: Maven plugin
 * 
 * $Id: GenerateNewsAnnouncementMojo.java 157 2010-10-08 10:23:16Z tchemit $
 * $HeadURL: http://svn.nuiton.org/svn/jredmine/tags/jredmine-1.1.4/maven-jredmine-plugin/src/main/java/org/nuiton/jredmine/plugin/announcement/GenerateNewsAnnouncementMojo.java $
 * %%
 * Copyright (C) 2009 - 2010 Tony Chemit, CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nuiton.jredmine.plugin.announcement;

/**
 * Generate the content of the release announcement news for Redmine.
 *
 * @author tchemit
 * @goal generate-news-announcement
 * @since 1.0.0
 */
public class GenerateNewsAnnouncementMojo extends AbstractAnnouncementMojo {

    /**
     * The Velocity template used to format the redmine announcement.
     *
     * @parameter expression="${redmine.newsAnnouncementTemplate}" default-value="release-news-announcement.vm"
     * @required
     * @since 1.0.0
     */
    protected String newsAnnouncementTemplate;

    /**
     * A flag to enable or disable the goal.
     *
     * @parameter expression="${redmine.skipGenerateNewsAnnouncement}" default-value="false"
     * @since 1.0.0
     */
    protected boolean skipGenerateNewsAnnouncement;

    @Override
    protected String getAnnouncementTemplate() {
        return newsAnnouncementTemplate;
    }

    @Override
    protected boolean isGoalSkip() {
        return skipGenerateNewsAnnouncement;
    }
}