CPAN-Reporter
view release on metacpan or search on metacpan
not reviewed by a human for accuracy") is included along with a blank
line before your C<comment.txt>, so that it is always possible to
distinguish automated tests from non-automated tests that use this
module.
Using CPAN::Reporter
Once CPAN::Reporter is enabled and configured, test or install modules
with CPAN.pm as usual.
For example, to test the File::Marker module:
cpan> test File::Marker
If a distribution's tests fail, users will be prompted to edit the
report to add additional information that might help the author
understand the failure.
UNDERSTANDING TEST GRADES
CPAN::Reporter will assign one of the following grades to the report:
* "pass" -- distribution built and tested correctly
* "fail" -- distribution failed to test correctly
* "unknown" -- distribution failed to build, had no test suite or
outcome was inconclusive
* "na" --- distribution is not applicable to this platform and/or
version of Perl
In returning results of the test suite to CPAN.pm, "pass" and "unknown"
are considered successful attempts to "make test" or "Build test" and
will not prevent installation. "fail" and "na" are considered to be
failures and CPAN.pm will not install unless forced.
An error from Makefile.PL/Build.PL or make/Build will also be graded as
"unknown" and a failure will be signaled to CPAN.pm.
If prerequisites specified in "Makefile.PL" or "Build.PL" are not
available, no report will be generated and a failure will be signaled to
CPAN.pm.
PRIVACY WARNING
CPAN::Reporter includes information in the test report about environment
variables and special Perl variables that could be affecting test
results in order to help module authors interpret the results of the
tests. This includes information about paths, terminal, locale,
user/group ID, installed toolchain modules (e.g. ExtUtils::MakeMaker)
and so on.
These have been intentionally limited to items that should not cause
harmful personal information to be revealed -- it does *not* include
your entire environment. Nevertheless, please do not use CPAN::Reporter
if you are concerned about the disclosure of this information as part of
your test report.
Users wishing to review this information may choose to edit the report
prior to sending it.
BUGS
Using command_timeout on Linux may cause problems. See
<https://rt.cpan.org/Ticket/Display.html?id=62310>
Please report any bugs or feature using the CPAN Request Tracker. Bugs
can be submitted through the web interface at
<http://rt.cpan.org/Dist/Display.html?Queue=CPAN-Reporter>
When submitting a bug or request, please include a test-file or a patch
to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
Information about CPAN::Testers:
* CPAN::Testers -- overview of CPAN Testers architecture stack
* <http://www.cpantesters.org> -- project home with all reports
* <http://wiki.cpantesters.org> -- documentation and wiki
Additional Documentation:
* CPAN::Reporter::Config -- advanced configuration settings
* CPAN::Reporter::FAQ -- hints and tips
SUPPORT
Bugs / Feature Requests
Please report any bugs or feature requests through the issue tracker at
<https://github.com/cpan-testers/CPAN-Reporter/issues>. You will be
notified automatically of any progress on your issue.
Source Code
This is open source software. The code repository is available for
public review and contribution under the terms of the license.
<https://github.com/cpan-testers/CPAN-Reporter>
git clone https://github.com/cpan-testers/CPAN-Reporter.git
AUTHOR
David Golden <dagolden@cpan.org>
CONTRIBUTORS
* Alexandr Ciornii <alexchorny@gmail.com>
* Breno G. de Oliveira <garu@cpan.org>
* Christian Walde <walde.christian@googlemail.com>
* David Cantrell <david@cantrell.org.uk>
* Ed J <mohawk2@users.noreply.github.com>
* Graham Knop <haarg@haarg.org>
* HÃÂ¥kon Hægland <hakon.hagland@gmail.com>
* James E Keenan <jkeenan@cpan.org>
* J. Maslak <jmaslak@antelope.net>
( run in 0.445 second using v1.01-cache-2.11-cpan-6aa56a78535 )