-
Notifications
You must be signed in to change notification settings - Fork 1
/
README
133 lines (91 loc) · 3.63 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
NAME
Dist::Zilla::Plugin::Bugtracker - Automatically sets the bugtracker URL
and mailto
VERSION
version 1.111080
SYNOPSIS
In "dist.ini":
[Bugtracker]
DESCRIPTION
This plugin sets the distribution's bugtracker URL and possibly the
email address as metadata. You can set the "web" and the "mailto" values
independently in the plugin configuration.
METHODS
web
This is the bugtracker URL. It defaults to the CPAN RT URL, so it
equivalent to:
[Bugtracker]
web = http://rt.cpan.org/Public/Dist/Display.html?Name=%s
See "interpolate()" for more information.
mailto
This is the optional email address to which bug reports can be sent. If
the CPAN RT bugtracker is used, the email address defaults to "bug-%l at
rt.cpan.org" - see "interpolate()" for what this means.
If a different bugtracker URL is used, the email address is only
included in the metadata if it is explicitly given.
In the following examples, assume that the distribution is called
"Foo-Bar".
Example 1:
[Bugtracker]
will produce the defaults:
web: http://rt.cpan.org/Public/Dist/Display.html?Name=Foo-Bar
mailto: bug-foo-bar at rt.cpan.org
Example 2:
To suppress the "mailto" from example 1, use:
[Bugtracker]
mailto =
Example 3:
[Bugtracker]
web = http://github.com/me/%s/issues
will only produce a "web" entry, but not a "mailto" entry:
web: http://github.com/me/Foo-Bar/issues
Example 4:
[Bugtracker]
mailto = [email protected]
will produce:
web: http://rt.cpan.org/Public/Dist/Display.html?Name=Foo-Bar
mailto: [email protected]
Example 5:
[Bugtracker]
web = http://github.com/me/%s/issues
mailto = bug-%[email protected]
will only produce a "web" entry, but not a "mailto" entry:
web: http://github.com/me/Foo-Bar/issues
mailto: [email protected]
See CPAN::Meta::Spec
<http://search.cpan.org/dist/CPAN-Meta/lib/CPAN/Meta/Spec.pm#resources>
for more information.
interpolate
Both the "web" and "mailto" strings are interpolated as follows:
%s The distribution name as is (e.g., 'Foo-Bar')
%l The distribution name in lowercase (e.g., 'foo-bar')
%U The distribution name in uppercase (e.g., 'FOO-BAR')
%% A literal '%' sign
metadata
Sets the bugtracker URL and possibly email address in the distribution's
metadata.
INSTALLATION
See perlmodinstall for information and options on installing Perl
modules.
BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests through the web interface at
<http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Bugt
racker>.
AVAILABILITY
The latest version of this module is available from the Comprehensive
Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a
CPAN site near you, or see
<http://search.cpan.org/dist/Dist-Zilla-Plugin-Bugtracker/>.
The development version lives at
<http://github.com/hanekomu/Dist-Zilla-Plugin-Bugtracker> and may be
cloned from
<git://github.com/hanekomu/Dist-Zilla-Plugin-Bugtracker.git>. Instead of
sending patches, please fork this project using the standard git and
github infrastructure.
AUTHOR
Marcel Gruenauer <[email protected]>
COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Marcel Gruenauer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.