CPAN::Reporter::Config - Config file options for CPAN::Reporter

version 1.1902

From the CPAN shell:

  cpan> o conf init test_report

Default options for CPAN::Reporter are read from a configuration file .cpanreporter/config.ini in the user's home directory.

The configuration file is in "ini" format, with the option name and value separated by an "=" sign

   email_from = "John Doe" <johndoe@nowhere.org>
   edit_report = no

Interactive configuration of email address, mail server 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.

CPAN::Reporter requires users to provide an email address that will be used in the "From" header of the email to cpan-testers@perl.org.

• email_from = <email address> -- email address of the user sending the test report; it should be a valid address format, e.g.:

  user@domain
  John Doe <user@domain>
  "John Q. Public" <user@domain>

Because cpan-testers uses a mailing list to collect test reports, it is helpful if the email address provided is subscribed to the list. Otherwise, test reports will be held until manually reviewed and approved.

Subscribing an account to the cpan-testers list is as easy as sending a blank email to cpan-testers-subscribe@perl.org and replying to the confirmation email.

By default, Test::Reporter attempts to send mail directly to perl.org mail servers. This may fail if a user's computer is behind a network firewall that blocks outbound email. In this case, the following option should be set to the outbound mail server (i.e., SMTP server) as provided by the user's Internet service provider (ISP):

• smtp_server = <server list> -- one or more alternate outbound mail servers if the default perl.org mail servers cannot be reached; multiple servers may be given, separated with a space (none by default)

In at least one reported case, an ISP's outbound mail servers also refused to forward mail unless the email_from was from the ISP-given email address.

Several steps in the generation of a test report are optional. Configuration options control whether an action should be taken automatically or whether CPAN::Reporter should prompt the user for the action to take. The action to take may be different for each report grade.

Valid actions, and their associated meaning, are as follows:

• yes -- automatic yes
• no -- automatic no
• ask/no or just ask -- ask each time, but default to no
• ask/yes -- ask each time, but default to yes

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:

• edit_report = <grade:action> ... -- edit the test report before sending? (default:ask/no pass/na:no)
• send_report = <grade:action> ... -- should test reports be sent at all? (default:ask/yes pass/na:yes)

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

These additional options are only necessary in special cases, for example if the default editor cannot be found or if reports shouldn't be sent in certain situations or for automated testing, and so on.

• command_timeout -- if greater than zero and the CPAN config is inactivity_timeout is not set, then any commands executed by CPAN::Reporter will be halted after this many seconds; useful for unattended smoke testing to stop after some amount of time; generally, this should be large -- 900 seconds or more -- as some distributions' tests take quite a long time to run. On MSWin32, Win32::Job is a needed and trying to kill a processes may actually deadlock in some situations -- so use at your own risk.
• editor = <editor> -- editor to use to edit the test report; if not set, Test::Reporter will use environment variables VISUAL, EDITOR or EDIT (in that order) to find an editor
• send_duplicates = <grade:action> ... -- should duplicates of previous reports be sent, regardless of send_report? (default:no)
• send_PL_report = <grade:action> ... -- if defined, used in place of send_report during the PL phase
• send_make_report = <grade:action> ... -- if defined, used in place of send_report during the make phase
• send_test_report = <grade:action> ... -- if defined, used in place of send_report during the test phase
• send_skipfile = <skipfile> -- filename containing regular expressions (one per line) to match against the distribution ID (e.g. 'AUTHOR/Dist-Name-0.01.tar.gz'); the report will not be sent if a match is found; non-absolute filename must be in the .cpanreporter config directory;
• transport = <transport> [transport args] -- if defined, passed to the transport() method of Test::Reporter. See below for more details. (CPAN::Reporter uses 'Net::SMTP' for this by default.)

If these options are manually added to the configuration file, they will be included (and preserved) in subsequent interactive configuration.

Skip files are expected to have one regular expression per line and will be matched against the distribution ID, composed of the author's CPAN ID and the distribution tarball name.

     DAGOLDEN/CPAN-Reporter-1.00.tar.gz

Lines that begin with a sharp (#) are considered comments and will not be matched. All regular expressionss 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

The Test::Reporter 1.39_XX development series added support for multiple transport modules, e.g. Test::Reporter::Transport::Net::SMTP::TLS or Test::Reporter::Transport::HTTPGateway. To use them with CPAN::Reporter, set the 'transport' config option to the name of the transport module (without the 'Test::Reporter::Transport' prefix) and any required arguments, separated by white space. For example:

   transport=Net::SMTP Port 587
   transport=Net::SMTP::TLS User jdoe@example.com Password 12345
   transport=HTTPGateway http://example.com/cpantesters.cgi MyKey
   transport=File ~/saved-reports-dir

The transport module may be any Test::Reporter::Transport installed on your system. As of Test::Reporter 1.39_05, transports included 'Net::SMTP', 'Net::SMTP::TLS', 'Mail::Send', 'HTTPGateway' and 'File'.

These options are useful for debugging only:

• debug = <boolean> -- turns debugging on/off
• email_to = <email address> -- alternate destination for reports instead of cpan-testers@perl.org; used for testing

The following environment variables may be set to alter the default locations for CPAN::Reporter files:

• PERL_CPAN_REPORTER_DIR -- if set, this directory is used in place of the default .cpanreporter directory; this will affect not only the location of the default config.ini, but also the location of the CPAN::Reporter::History database and any other files that live in that directory
• PERL_CPAN_REPORTER_CONFIG -- if set, this file is used in place of the default config.ini file; it may be in any directory, regardless of the choice of configuration directory

• CPAN::Reporter
• CPAN::Reporter::History
• CPAN::Reporter::FAQ

David A. Golden (DAGOLDEN)

Copyright (c) 2006, 2007, 2008 by David A. Golden

Licensed 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.

David Golden <dagolden@cpan.org>

This software is Copyright (c) 2006 by David Golden.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004