1 /*
2 * Copyright 2008-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.maven.issues.bugzilla;
17
18 /**
19 * The report to generate release notes.
20 *
21 * @goal bugzilla-releasenotes-report
22 * @phase site
23 * @requiresProject
24 * @description Generates a release report using issues from the issues
25 * management system.
26 * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
27 * @version $Revision:591 $
28 */
29 public class BugzillaReleaseNotesReportMojo extends BugzillaSectionReportMojo
30 {
31 // ********************************* Fields *********************************
32
33 // --- constants ------------------------------------------------------------
34
35 // --- members --------------------------------------------------------------
36
37 /**
38 * Specifies the name of the file to write the issues report (without
39 * extension).
40 *
41 * @parameter expression="${issues.release.report.fileName}"
42 * default-value="release-notes-report"
43 * @required
44 * @since 1.0
45 */
46 private String outputName;
47
48 /**
49 * Lists the columns to be rendered. Each element of this list is a property
50 * of an issue. The identifiers given here must match the ones defined in the
51 * referenced issue management system. E.g. for Bugzilla these are defined in
52 * <code>org.eclipse.mylyn.internal.bugzilla.core.BugzillaAttribute</code>.
53 * <p>
54 * The values are separated by comma.
55 * </p>
56 *
57 * @parameter default-value=
58 * "bug_id,short_desc,resolution,bug_severity"
59 * @required
60 * @since 1.0
61 */
62 private String columns;
63
64 /**
65 * Lists the column width to be used to set to the columns. If the value is
66 * <code>0</code> (zero) no width will be set explicitly for that column.
67 *
68 * @parameter default-value= "65,0,100,100"
69 * @required
70 * @since 1.0
71 */
72 private String columnWidths;
73
74 // ****************************** Initializer *******************************
75
76 // ****************************** Constructors ******************************
77
78 // ****************************** Inner Classes *****************************
79
80 // ********************************* Methods ********************************
81
82 // --- init -----------------------------------------------------------------
83
84 // --- get&set --------------------------------------------------------------
85
86 /**
87 * {@inheritDoc}
88 *
89 * @see org.apache.maven.reporting.MavenReport#getOutputName()
90 */
91 public String getOutputName()
92 {
93 return outputName;
94 }
95
96 // ... report related .......................................................
97
98 /**
99 * Returns the value for columns.
100 * <p>
101 * Lists the columns to be rendered. Each element of this list is a property
102 * of an issue. The identifiers given here must match the ones defined in the
103 * referenced issue management system. E.g. for Bugzilla these are defined in
104 * {@link org.eclipse.mylyn.internal.bugzilla.core.BugzillaAttribute}.
105 * <p>
106 * The values are separated by comma.
107 * </p>
108 *
109 * @return the value for columns.
110 */
111 protected String getColumns()
112 {
113 return columns;
114 }
115
116 /**
117 * Returns the value for columnWidths.
118 * <p>
119 * Lists the column width to be used to set to the columns. If the value is
120 * <code>0</code> (zero) no width will be set explicitly for that column.
121 * </p>
122 *
123 * @return the value for columnWidths.
124 */
125 protected String getColumnWidths()
126 {
127 return columnWidths;
128 }
129
130 // --- business -------------------------------------------------------------
131
132 // --- object basics --------------------------------------------------------
133
134 }