cpan> o conf init test_report
The configuration file is in "ini" format, with the option name and value separated by an "=" sign
email_from = "John Doe" <email@example.com> edit_report = no
Interactive configuration of email address and common action prompts may be repeated at any time from the CPAN shell.
cpan> o conf init test_report
If a configuration file does not exist, it will be created the first time interactive configuration is performed.
Subsequent interactive configuration will also include any advanced options that have been added manually to the configuration file.
email_from = <email address>
CPAN::Reporter requires users to provide an email address that will be used in the header of the report.
The email address provided should be a valid address format, e.g.:
email_from = user@domain email_from = John Doe <user@domain> email_from = "John Q. Public" <user@domain>
transport = <transport class> [transport args]
This sets the transport mechanism passed to the "transport()" method of Test::Reporter. Normally, CPAN::Reporter uses 'Metabase' for transport class (i.e. Test::Reporter::Transport::Metabase) and will provide a default set of transport arguments.
Metabase transport arguments are two space-separated key/value pairs:
Prior to sending reports, a user must have a valid profile file at the path specified. For Metabase transport, CPAN::Reporter will automatically rewrite a relative "id_file" path as an absolute path located in the ".cpanreporter" directory.
If the specified profile file does not exist, CPAN::Reporter will offer to run "metabase-profile" to create it.
For other transport types, see the documentation that comes with your choice of Test::Reporter::Transport subclass for the proper way to set the "transport" configuration option.
Most users should just accept the default settings until they have some experience as CPAN Testers.
Valid actions, and their associated meaning, are as follows:
For "ask" prompts, the default will be used if return is pressed immediately at the prompt or if the "PERL_MM_USE_DEFAULT" environment variable is set to a true value.
Action prompt options take one or more space-separated "grade:action" pairs, which are processed left to right.
edit_report = fail:ask/yes pass:no
An action by itself is taken as a default to be used for any grade which does not have a grade-specific action. A default action may also be set by using the word "default" in place of a grade.
edit_report = ask/no edit_report = default:ask/no
A grade by itself is taken to have the action "yes" for that grade.
edit_report = default:no fail
Multiple grades may be specified together by separating them with a slash.
edit_report = pass:no fail/na/unknown:ask/yes
The action prompt options included in interactive configuration are:
Note that if "send_report" is set to "no", CPAN::Reporter will still go through the motions of preparing a report, but will discard it rather than send it.
A better way to disable CPAN::Reporter temporarily is with the CPAN option "test_report":
cpan> o conf test_report 0
If these options are manually added to the configuration file, they will be included (and preserved) in subsequent interactive configuration.
Lines that begin with a sharp (#) are considered comments and will not be matched. All regular expressions will be matched case insensitive and will not be anchored unless you provide one.
As the format of a distribution ID is "AUTHOR/tarball", anchoring at the start of the line with a caret (^) will match the author and with a slash (/) will match the distribution.
# any distributions by JOHNDOE ^JOHNDOE # any distributions starting with Win32 /Win32 # a particular very specific distribution ^JOHNDOE/Foo-Bar-3.14
This is free software, licensed under:
The Apache License, Version 2.0, January 2004