Changes Tester Project

------ Usage ------ Johnny R. Ruiz III Allan Ramirez ------ 2 September 2005 ------ ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file ~~ distributed with this work for additional information ~~ regarding copyright ownership. The ASF licenses this file ~~ to you 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. ~~ NOTE: For help with the syntax of this file, see: ~~ http://maven.apache.org/guides/mini/guide-apt-format.html Usage This plugin is used to create a Changes Report, a JIRA Report and an Announcement text file. *How to Generate the Changes Report In order to use this plugin, simply create a <<>> file under the <<>> directory. Here's an example of a typical <<>>, showing the syntax: ------------------- Changes Tester Project Johnny R. Ruiz III Added additional documentation on how to configure the plugin. Enable retrieving component-specific issues. The element type " link " must be terminated by the matching end-tag. Deleted the erroneous code. Uploaded documentation on how to use the plugin. ------------------- The following attributes are supported for the <<<\>>> element: *--------------------+--------------*------------------------------------------------------------------------------------------+ <> | <> | <> *--------------------+--------------*------------------------------------------------------------------------------------------+ version | Required | Name of the version in which the changes occur. For each change, add a nested <<<\>>> element as described below. *--------------------+--------------*------------------------------------------------------------------------------------------+ date | Required | Date at which the version was released. You can use a free form comment such as "in SVN" for unreleased versions. *--------------------+--------------*------------------------------------------------------------------------------------------+ description | Optional | An optional description of the release. This is used in the overview table of releases. <> In releases prior to 2.0-beta-2 this was called <<>>. It was changed to improve compatibility with the Maven 1 changes plugin. *--------------------+--------------*------------------------------------------------------------------------------------------+ The following attributes are supported for the <<<\>>> element: *--------------------+--------------*------------------------------------------------------------------------------------------+ <> | <> | <> *--------------------+--------------*------------------------------------------------------------------------------------------+ dev | Required | Name of developer who committed the change. This must be the name of the developer as described in the developers section of the <<>> file. *--------------------+--------------*------------------------------------------------------------------------------------------+ type | Required | Type of change. There are four valid values: , , , . *--------------------+--------------*------------------------------------------------------------------------------------------+ issue | Optional | Id of the issue related to this change. This is the id in your issue tracking system. | | The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the <<>> parameter. See the {{{changes-report-mojo.html}changes-report mojo}} for more details. *--------------------+--------------*------------------------------------------------------------------------------------------+ due-to | Optional | Name of the person to be credited for this change. This can be used when a patch is submitted by a non-committer. *--------------------+--------------*------------------------------------------------------------------------------------------+ due-to-email | Optional | Email of the person to be credited for this change. *--------------------+--------------*------------------------------------------------------------------------------------------+ To generate the changes report, insert the changes plugin in the <<<\>>> section of your project <<>> ------------------- ... org.apache.maven.plugins maven-changes-plugin changes-report ... ------------------- and execute the site goal to generate the report. ------------------- mvn site ------------------- ** Linking to Your Issue Management System If you use the <<>> attribute in your <<>> file and have the <<<\>>> element configured in your <<>>, the report will contain links to the issues in your issue management system. The default configuration produces links to JIRA, but that can be {{{changes-report-mojo.html}configured}}. <> If you have another issue tracker, make sure that your <<<\/\>>> is correct. In particular, make sure that it has a trailing slash if it needs one. The plugin can't add this for you, because it needs to handle different issue management systems. If your issue management system is at <<>> the links will not work if you enter <<>> in your <<>>. *How to Generate the JIRA Report <> To use the JIRA Report, the <<<\>>> section in the <<>> of the project must be configured. Sample code inside your <<>>: ------------------- ... http://jira.codehaus.org/BrowseProject.jspa?id=10450 ... ------------------- To generate the JIRA report, insert the changes plugin in the <<<\>>> section of your project <<>> ------------------- ... org.apache.maven.plugins maven-changes-plugin jira-report ... ------------------- and execute the site goal to generate the report. ------------------- mvn site ------------------- *How to generate and send the Announcement in Email In your project <<>>, insert this segment: ------------------- ... org.apache.maven.plugins maven-changes-plugin announcement-generate announcement-generate announcement-mail announcement-mail mail.yourhost.com 25 someones@email.com anothersomeone@email.com ... ------------------- You can generate the announcement by executing the command below: ------------------- mvn changes:announcement-generate ------------------- If you want to generate the announcement based on JIRA you would execute the following command: ------------------- mvn changes:announcement-generate -DgenerateJiraAnnouncement=true ------------------- This is how you send an email with the generated announcement: ------------------- mvn changes:announcement-mail -------------------