1CPAN::Reporter::Config(U3s)er Contributed Perl DocumentatCiPoAnN::Reporter::Config(3)
2
6 CPAN::Reporter::Config - Config file options for CPAN::Reporter
7
9 version 1.2018
10
12 From the CPAN shell:
13 cpan> o conf init test_report
15
17 Default options for CPAN::Reporter are read from a configuration file
18 ".cpanreporter/config.ini" in the user's home directory. (On Win32
19 platforms, the directory will be located in the user's "Documents"
20 directory.) The location of the configuration directory or file may be
21 specified using environment variables instead.
22 The configuration file is in "ini" format, with the option name and
24 value separated by an "=" sign
25 email_from = "John Doe" <johndoe@nowhere.org>
27 edit_report = no
28 Interactive configuration of email address and common action prompts
30 may be repeated at any time from the CPAN shell.
31 cpan> o conf init test_report
33 If a configuration file does not exist, it will be created the first
35 time interactive configuration is performed.
36 Subsequent interactive configuration will also include any advanced
38 options that have been added manually to the configuration file.
39
41 Email Address (required)
42 email_from = <email address>
43 CPAN::Reporter requires users to provide an email address that will be
45 used in the header of the report.
46 The email address provided should be a valid address format, e.g.:
48 email_from = user@domain
50 email_from = John Doe <user@domain>
51 email_from = "John Q. Public" <user@domain>
52 Transport (required)
54 transport = <transport class> [transport args]
55 This sets the transport mechanism passed to the "transport()" method of
57 Test::Reporter. Normally, CPAN::Reporter uses 'Metabase' for transport
58 class (i.e. Test::Reporter::Transport::Metabase) and will provide a
59 default set of transport arguments.
60 Metabase transport arguments are two space-separated key/value pairs:
62 · "uri" -- URI for the Metabase API. Defaults to
64 "https://metabase.cpantesters.org/api/v1/"
65 · "id_file" -- path to the user's Metabase profile file. Defaults to
67 "metabase_id.json". (Assumed to be in the ".cpanreporter"
68 directory).
69 Prior to sending reports, a user must have a valid profile file at the
71 path specified. For Metabase transport, CPAN::Reporter will
72 automatically rewrite a relative "id_file" path as an absolute path
73 located in the ".cpanreporter" directory.
74 If the specified profile file does not exist, CPAN::Reporter will offer
76 to run "metabase-profile" to create it.
77 For other transport types, see the documentation that comes with your
79 choice of Test::Reporter::Transport subclass for the proper way to set
80 the "transport" configuration option.
81 Action Prompts
83 Several steps in the generation of a test report are optional.
84 Configuration options control whether an action should be taken
85 automatically or whether CPAN::Reporter should prompt the user for the
86 action to take. The action to take may be different for each report
87 grade. For example, users may wish to customize for which grades they
88 wish to manually review a report before sending it.
89 Most users should just accept the default settings until they have some
91 experience as CPAN Testers.
92 Valid actions, and their associated meaning, are as follows:
94 · "yes" -- automatic yes
96 · "no" -- automatic no
98 · "ask/no" or just "ask" -- ask each time, but default to no
100 · "ask/yes" -- ask each time, but default to yes
102 For "ask" prompts, the default will be used if return is pressed
104 immediately at the prompt or if the "PERL_MM_USE_DEFAULT" environment
105 variable is set to a true value.
106 Action prompt options take one or more space-separated "grade:action"
108 pairs, which are processed left to right.
109 edit_report = fail:ask/yes pass:no
111 An action by itself is taken as a default to be used for any grade
113 which does not have a grade-specific action. A default action may also
114 be set by using the word "default" in place of a grade.
115 edit_report = ask/no
117 edit_report = default:ask/no
118 A grade by itself is taken to have the action "yes" for that grade.
120 edit_report = default:no fail
122 Multiple grades may be specified together by separating them with a
124 slash.
125 edit_report = pass:no fail/na/unknown:ask/yes
127 The action prompt options included in interactive configuration are:
129 · "edit_report = <grade:action> ..." -- edit the test report before
131 sending? (default:ask/no pass/na:no)
132 · "send_report = <grade:action> ..." -- should test reports be sent
134 at all? (default:ask/yes pass/na:yes)
135 Note that if "send_report" is set to "no", CPAN::Reporter will still go
137 through the motions of preparing a report, but will discard it rather
138 than send it.
139 A better way to disable CPAN::Reporter temporarily is with the CPAN
141 option "test_report":
142 cpan> o conf test_report 0
144 Mail Server (DEPRECATED)
146 CPAN::Reporter used to send mail directly to perl.org mail servers. The
147 "smtp_server" option is now deprecated and will be ignored if it
148 exists.
149
151 These additional options are only necessary in special cases, for
152 example if the default editor cannot be found or if reports shouldn't
153 be sent in certain situations or for automated testing, and so on.
154 · "command_timeout" -- if greater than zero and the CPAN config is
156 "inactivity_timeout" is not set, then any commands executed by
157 CPAN::Reporter will be halted after this many seconds; useful for
158 unattended smoke testing to stop after some amount of time;
159 generally, this should be large -- 900 seconds or more -- as some
160 distributions' tests take quite a long time to run. On MSWin32,
161 Win32::Job is a needed and trying to kill a process may actually
162 deadlock in some situations -- so use at your own risk.
163 · "editor = <editor>" -- editor to use to edit the test report; if
165 not set, Test::Reporter will use environment variables "VISUAL",
166 "EDITOR" or "EDIT" (in that order) to find an editor
167 · "retry_submission" -- if greater than zero, CPAN::Reporter will try
169 to resend the report after a few seconds in case the first attempt
170 fails.
171 · "send_duplicates = <grade:action> ..." -- should duplicates of
173 previous reports be sent, regardless of "send_report"? (default:no)
174 · "send_PL_report = <grade:action> ..." -- if defined, used in place
176 of "send_report" during the PL phase
177 · "send_make_report = <grade:action> ..." -- if defined, used in
179 place of "send_report" during the make phase
180 · "send_test_report = <grade:action> ..." -- if defined, used in
182 place of "send_report" during the test phase
183 · "send_skipfile = <skipfile>" -- filename containing regular
185 expressions (one per line) to match against the distribution ID
186 (e.g. 'AUTHOR/Dist-Name-0.01.tar.gz'); the report will not be sent
187 if a match is found; non-absolute filename must be in the
188 .cpanreporter config directory;
189 If these options are manually added to the configuration file, they
191 will be included (and preserved) in subsequent interactive
192 configuration.
193 Skipfile regular expressions
195 Skip files are expected to have one regular expression per line and
196 will be matched against the distribution ID, composed of the author's
197 CPAN ID and the distribution tarball name.
198 DAGOLDEN/CPAN-Reporter-1.00.tar.gz
200 Lines that begin with a sharp (#) are considered comments and will not
202 be matched. All regular expressions will be matched case insensitive
203 and will not be anchored unless you provide one.
204 As the format of a distribution ID is "AUTHOR/tarball", anchoring at
206 the start of the line with a caret (^) will match the author and with a
207 slash (/) will match the distribution.
208 # any distributions by JOHNDOE
210 ^JOHNDOE
211 # any distributions starting with Win32
212 /Win32
213 # a particular very specific distribution
214 ^JOHNDOE/Foo-Bar-3.14
215
217 These options are useful for debugging only:
218 · "debug = <boolean>" -- turns debugging on/off
220
222 The following environment variables may be set to alter the default
223 locations for CPAN::Reporter files:
224 · "PERL_CPAN_REPORTER_DIR" -- if set, this directory is used in place
226 of the default ".cpanreporter" directory; this will affect not only
227 the location of the default "config.ini", but also the location of
228 the CPAN::Reporter::History database and any other files that live
229 in that directory
230 · "PERL_CPAN_REPORTER_CONFIG" -- if set, this file is used in place
232 of the default "config.ini" file; it may be in any directory,
233 regardless of the choice of configuration directory
234
236 · CPAN::Reporter
237 · CPAN::Reporter::History
239 · CPAN::Reporter::FAQ
241
243 David Golden <dagolden@cpan.org>
244
246 This software is Copyright (c) 2006 by David Golden.
247 This is free software, licensed under:
249 The Apache License, Version 2.0, January 2004
251perl v5.30.0 2019-07-26 CPAN::Reporter::Config(3)