Changes Tester Project

------ Usage ------ Johnny R. Ruiz III Allan Ramirez ------ 2009-08-04 ------ ~~ 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/doxia/references/apt-format.html Usage This plugin is used to create a Changes Report, a JIRA Report and an Announcement text file. It is also able to send the announcement via email. *How to Generate the Changes Report In order to use this goal, simply create a <<>> file in 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. ------------------- See the {{{changes.html}Changes Reference}} for details regarding the <<<\>>> and <<<\>>> elements and their attributes. To generate the Changes Report, insert the Changes Plugin in the <<<\>>> section of your project's <<>> ------------------- ... org.apache.maven.plugins maven-changes-plugin ${project.version} 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 your project must be configured. It might look something like this: ------------------- ... JIRA http://jira.codehaus.org/BrowseProject.jspa?id=10450 ... ------------------- To generate the JIRA Report, insert the Changes Plugin in the <<<\>>> section of your project's <<>> ------------------- ... org.apache.maven.plugins maven-changes-plugin ${project.version} jira-report ... ------------------- and execute the site goal to generate the report. ------------------- mvn site ------------------- For info on how to modify the JIRA Report see the {{{examples/customizing-jira-report.html}Customizing the JIRA Report}} example. *How to generate and send the Announcement via Email As usual we start by configuring your project's <<>>. We add a basic configuration for sending emails and specify the lucky recipients of the announcement emails. For info on how to change the sender of the email see the {{{examples/specifying-mail-sender.html}Specifying the mail sender}} example. ------------------- ... org.apache.maven.plugins maven-changes-plugin ${project.version} ... mail.yourhost.com 25 someones@email.com anothersomeone@email.com ... ... ------------------- You can now generate the announcement by executing the command below: ------------------- mvn changes:announcement-generate ------------------- If you want to generate the announcement based on JIRA you would either configure it in your <<>> or you would add the appropriate parameter on the command line, like this: ------------------- mvn changes:announcement-generate -DgenerateJiraAnnouncement=true ------------------- This is how you send an email with the generated announcement: ------------------- mvn changes:announcement-mail -------------------