Author: tchemit Date: 2010-01-24 19:31:09 +0100 (Sun, 24 Jan 2010) New Revision: 118 Removed: trunk/maven-jredmine-plugin/src/site/apt/Todo.apt Modified: trunk/maven-jredmine-plugin/src/site/apt/index.apt trunk/maven-jredmine-plugin/src/site/apt/usage.apt Log: do usage documentation page + fix broken links Deleted: trunk/maven-jredmine-plugin/src/site/apt/Todo.apt =================================================================== --- trunk/maven-jredmine-plugin/src/site/apt/Todo.apt 2010-01-24 15:52:43 UTC (rev 117) +++ trunk/maven-jredmine-plugin/src/site/apt/Todo.apt 2010-01-24 18:31:09 UTC (rev 118) @@ -1,8 +0,0 @@ ----- -TODO ----- ----- -2009-0906 ----- - -Any idea ? Modified: trunk/maven-jredmine-plugin/src/site/apt/index.apt =================================================================== --- trunk/maven-jredmine-plugin/src/site/apt/index.apt 2010-01-24 15:52:43 UTC (rev 117) +++ trunk/maven-jredmine-plugin/src/site/apt/index.apt 2010-01-24 18:31:09 UTC (rev 118) @@ -17,49 +17,47 @@ The plugin has the following goals: + * {{{./display-data-mojo.html}display-data}} display some datas from a redmine server. - * {{{display-data-mojo.html}display-data}} display some datas from a redmine server. + * {{{./generate-changes-mojo.html}generate-changes}} generates the changes.xml files from issues of the project from a redmine server. - * {{{generate-changes-mojo.html}generate-changes}} generates the changes.xml files from issues of the project from a redmine server. + * {{{./publish-attachments-mojo.html}publish-attachments}} publish some files as attachment for the version of the project on a redmine server. - * {{{publish-attachments-mojo.html}publish-attachments}} publish some files as attachment for the version of the project on a redmine server. + * {{{./publish-news-mojo.html}publish-news}} publish a news for the project on a redmine server. - * {{{publish-news-mojo.html}publish-news}} publish a news for the project on a redmine server. + * {{{./generate-email-announcement-mojo.html}generate-email-announcement}} generates the body of the email to send for a release using issues for the redmine server. - * {{{generate-email-announcement-mojo.html}generate-email-announcement}} generates the body of the email to send for a release using issues for the redmine server. + * {{{./generate-news-announcement-mojo.html}generate-news-announcement}} generates the body of the announcement's news to publish for a release using issues for the redmine server. - * {{{generate-news-announcement-mojo.html}generate-news-announcement}} generates the body of the announcement's news to publish for a release using issues for the redmine server. + * {{{./update-version-mojo.html}update-version}} update the version of the project (close version) on a redmine server. - * {{{update-version-mojo.html}update-version}} update the version of the project (close version) on a redmine server. + * {{{./next-version-mojo.html}next-version}} creates (if not exists) the version fo the project on a redmine server. - * {{{next-version-mojo.html}next-version}} creates (if not exists) the version fo the project on a redmine server. + * {{{./help-mojo.html}help}} display help about the plugin (goals, usage). - * {{{help-mojo.html}help}} display help about the plugin (goals, usage). - * Reports Overview The plugin has the following reports: + * {{{./issues-report-mojo.html}issues-report}} generates a report for issues from Redmine's server. - * {{{issues-report-mojo.html}issues-report}} generates a report for issues from Redmine's server. + * {{{./issues-report-by-tracker-mojo.html}issues-report-by-tracker}} generates a report for issues group by tracker's types from Redmine's server. - * {{{issues-report-by-tracker-mojo.html}issues-report-by-tracker}} generates a report for issues group by tracker's types from Redmine's server. + * {{{./issues-report-by-assignee-mojo.html}issues-report-by-assignee}} generates a report for issues group by assignee from Redmine's server. - * {{{issues-report-by-assignee-mojo.html}issues-report-by-assignee}} generates a report for issues group by assignee from Redmine's server. + * {{{./issues-report-by-category-mojo.html}issues-report-by-category}} generates a report for issues group by category from Redmine's server. - * {{{issues-report-by-category-mojo.html}issues-report-by-category}} generates a report for issues group by category from Redmine's server. + * {{{./issues-report-by-priority-mojo.html}issues-report-by-priority}} generates a report for issues group by priority from Redmine's server. - * {{{issues-report-by-priority-mojo.html}issues-report-by-priority}} generates a report for issues group by priority from Redmine's server. + * {{{./issues-report-by-reporter-mojo.html}issues-report-by-reporter}} generates a report for issues group by reporter from Redmine's server. - * {{{issues-report-by-reporter-mojo.html}issues-report-by-reporter}} generates a report for issues group by reporter from Redmine's server. + * {{{./issues-report-by-status-mojo.html}issues-report-by-status}} generates a report for issues group by status from Redmine's server. - * {{{issues-report-by-status-mojo.html}issues-report-by-status}} generates a report for issues group by status from Redmine's server. + * {{{./issues-report-by-version-mojo.html}issues-report-by-version}} generates a report for issues group by version from Redmine's server. - * {{{issues-report-by-version-mojo.html}issues-report-by-version}} generates a report for issues group by version from Redmine's server. - * Usage - Instructions on how to use the Plugin can be found on {{{usage.html}usage}} page + Instructions on how to use the Plugin can be found on {{{./usage.html}usage}} page * Examples Modified: trunk/maven-jredmine-plugin/src/site/apt/usage.apt =================================================================== --- trunk/maven-jredmine-plugin/src/site/apt/usage.apt 2010-01-24 15:52:43 UTC (rev 117) +++ trunk/maven-jredmine-plugin/src/site/apt/usage.apt 2010-01-24 18:31:09 UTC (rev 118) @@ -5,10 +5,22 @@ 2009-09-06 ---- -generate-changes goal +Abstract + This page describes usages of different goals of the plugin. + +Generate things + +* Generate the changes.xml file + + This execution will change the changes.xml file in + ------------------------------------------------------------------------------ +target/generated-sources/changes/changes.xml +------------------------------------------------------------------------------ +------------------------------------------------------------------------------ + <plugin> <groupId>org.nuiton.jredmine</groupId> <artifactId>maven-jredmine-plugin</artifactId> @@ -21,6 +33,7 @@ </execution> </executions> <configuration> + <projectId>myProject</projectId> <generateOnce>true</generateOnce> <actionMapping>fix:1, add:2</actionMapping> <statusIds>3,4,5</statusIds> @@ -28,12 +41,10 @@ </plugin> ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./generate-changes-mojo.html}here}}. - //TODO-FILL_ME +* Generate the release email announcement content -generate-email-announcement goal - ------------------------------------------------------------------------------ <plugin> @@ -48,6 +59,7 @@ </execution> </executions> <configuration> + <projectId>myProject</projectId> <urlDownload> ${redmine.url}/projects/list_files/${projectId} </urlDownload> @@ -55,12 +67,10 @@ </plugin> ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./generate-email-announcement-mojo.html}here}}. - //TODO-FILL_ME +* Generate the release news announcement content -generate-news-announcement goal - ------------------------------------------------------------------------------ <plugin> @@ -75,6 +85,7 @@ </execution> </executions> <configuration> + <projectId>myProject</projectId> <urlDownload> ${redmine.url}/projects/list_files/${projectId} </urlDownload> @@ -82,11 +93,13 @@ </plugin> ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./generate-news-announcement-mojo.html}here}}. - //TODO-FILL_ME +Work around a release -update-version goal + In this section we show how to interact when releasing a project. + +* Release the current version ------------------------------------------------------------------------------ @@ -102,6 +115,8 @@ </execution> </executions> <configuration> + <projectId>myProject</projectId> + <versionId>1.0.0</versionId> <closeVersion>true</closeVersion> </configuration> </plugin> @@ -114,12 +129,10 @@ mvn jredmine:update-version -DcloseVersion ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./update-version-mojo.html}here}}. - //TODO-FILL_ME +* Create a new version -next-version goal - ------------------------------------------------------------------------------ <plugin> @@ -134,6 +147,8 @@ </execution> </executions> <configuration> + <projectId>myProject</projectId> + <versionId>1.1</versionId> <previousVersionName>1.0</previousVersionName> </configuration> </plugin> @@ -146,12 +161,10 @@ mvn jredmine:next-version -DpreviousVersionName=1.0 ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./next-version-mojo.html}here}}. - //TODO-FILL_ME +* Publish some file to a redmine server -publish-attachments goal - ------------------------------------------------------------------------------ <plugin> @@ -161,12 +174,14 @@ <execution> <goals> <goal>publish-attachments</goal> - <goal>publish-news</goal> </goals> <phase>validate</phase> </execution> </executions> <configuration> + <projectId>myProject</projectId> + <versionId>1.0</versionId> + <!-- for a multi-module just run on root project --> <runOnce>true</runOnce> @@ -176,12 +191,10 @@ </plugin> ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./publish-attachments-mojo.html}here}}. - //TODO-FILL_ME +* Publish an news to a redmine server -publish-news goal - ------------------------------------------------------------------------------ <plugin> @@ -196,6 +209,7 @@ </execution> </executions> <configuration> + <projectId>myProject</projectId> <!-- for a multi-module just run on root project --> <runOnce>true</runOnce> @@ -209,11 +223,11 @@ </plugin> ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./publish-news-mojo.html}here}}. - //TODO-FILL_ME +Obtain help -help goal +* get mojo help This goal display the help of the plugin (available goals). @@ -230,16 +244,48 @@ mvn jredmine:help -Ddetail ------------------------------------------------------------------------------ - for full detail see {{{help-mojo.html}help}} detail page. + Full detail about this goal can be found {{{./help-mojo.html}here}}. -issues-report report +* Obtain datas from redmine server + + This goal display some datas from a redmine server. + + + for example, to obtain all users of the jredmine project, launch directly + from commandline : + ------------------------------------------------------------------------------ + mvn jredmine:display-data -DprojectId=jredmine -Dtypes=user +------------------------------------------------------------------------------ + + will display this + +------------------------------------------------------------------------------ +Values of 'user' for project 'jredmine' + - 3 = Jean Couteau + - 5 = Éric Chatellier + - 7 = Tony Chemit +------------------------------------------------------------------------------ + + Full detail about this goal can be found {{{./display-data-mojo.html}here}}. + +Do reports + + There is some reports on the issues of the redmine server. + +* Reports all issues form a project + + Basic issue report with no grouping. + +------------------------------------------------------------------------------ + <plugin> <groupId>org.nuiton.jredmine</groupId> <artifactId>maven-jredmine-plugin</artifactId> <configuration> + <projectId>myProject</projectId> <columnNames> key,summary,status,assignee,tracker,priority,version,category,createdOn </columnNames> @@ -254,6 +300,65 @@ </plugin> ------------------------------------------------------------------------------ -* How does it work ? + Full detail about this goal can be found {{{./issues-report-mojo.html}here}}. - //TODO-FILL_ME +* Reports all issues form a project group by XXX + + Issue report with a grouping property among : + + - assignee + + - category + + - priority + + - reporter + + - status + + - tracker + + - version + + [] + . + for example generate a report of issues grouped by version : + +------------------------------------------------------------------------------ + +<plugin> + <groupId>org.nuiton.jredmine</groupId> + <artifactId>maven-jredmine-plugin</artifactId> + <configuration> + <projectId>myProject</projectId> + <columnNamesByVersion> + key,summary,status,assignee,tracker,priority,category,createdOn + </columnNamesByVersion> + </configuration> + <reportSets> + <reportSet> + <reports> + <report>issues-report-by-version</report> + </reports> + </reportSet> + </reportSets> +</plugin> +------------------------------------------------------------------------------ + + Full detail about this goal can be found here : + + - {{{./issues-report-by-assignee-mojo.html}group by assignee}}. + + - {{{./issues-report-by-category-mojo.html}group by category}}. + + - {{{./issues-report-by-priority-mojo.html}group by priority}}. + + - {{{./issues-report-by-reporter-mojo.html}group by reporter}}. + + - {{{./issues-report-by-status-mojo.html}group by status}}. + + - {{{./issues-report-by-tracker-mojo.html}group by tracker}}. + + - {{{./issues-report-by-version-mojo.html}group by version}}. + + [] \ No newline at end of file