File: README

package info (click to toggle)
libdist-zilla-plugin-autometaresources-perl 1.21-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 168 kB
  • sloc: perl: 136; makefile: 2
file content (186 lines) | stat: -rw-r--r-- 5,319 bytes parent folder | download | duplicates (3)
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
NAME
    Dist::Zilla::Plugin::AutoMetaResources - Automagical MetaResources

VERSION
    version 1.21

SYNOPSIS
        # dist.ini
        name = Dist-Zilla-Plugin-AutoMetaResources
        ...

        [AutoMetaResources]
        bugtracker.github  = user:ajgb
        repository.github  = user:ajgb
        homepage           = https://metacpan.org/release/%{dist}

    or in PluginBundle::Easy

        $self->add_plugins(
            [
                AutoMetaResources => {
                    'bugtracker.github' => [{ user => 'ajgb' }],
                    'repository.github' => [{ user => 'ajgb' }],
                    'homepage' => 'https://metacpan.org/release/%{dist}',
                }
            ]
        );

    both for Dist::Zilla::Plugin::AutoMetaResources would be equivalent of

        [MetaResources]
        bugtracker.web    = https://github.com/ajgb/dist-zilla-plugin-autometaresources/issues
        repository.url    = git://github.com/ajgb/dist-zilla-plugin-autometaresources.git
        repository.web    = http://github.com/ajgb/dist-zilla-plugin-autometaresources
        repository.type   = git
        homepage          = https://metacpan.org/release/Dist-Zilla-Plugin-AutoMetaResources

DESCRIPTION
    If you find repeating the dist name again in the configuration really
    annoying, this plugin comes to the rescue!

CONFIGURATION
    Most of the known resources requires just boolean flag to be enabled,
    but you are free to pass your own options:

        bugtracker.rt =  dist:Other-Name;lcdist:other-name

    which is transformed to:

        [{
            dist => 'Other-Name',
            lcdist => 'other-name',
        }]

  BUGTRACKER
    RT bugtracker:

        [AutoMetaResources]
        bugtracker.rt = 1

        # same as
        [MetaResources]
        bugtracker.web    = https://rt.cpan.org/Public/Dist/Display.html?Name=%{dist}
        bugtracker.mailto = bug-%{dist}@rt.cpan.org

    GitHub issues:

        [AutoMetaResources]
        bugtracker.github = user:ajgb

        # same as
        [MetaResources]
        bugtracker.web    = http://github.com/ajgb/%{lcdist}/issues

    Bitbucket issues:

        [AutoMetaResources]
        bugtracker.bitbucket = user:ajgb

        # same as
        [MetaResources]
        bugtracker.web    = https://bitbucket.org/ajgb/%{lcdist}/issues

  REPOSITORY
    GitHub repository:

        [AutoMetaResources]
        repository.github = user:ajgb
        # or
        repository.GitHub = user:ajgb

        # same as
        [MetaResources]
        repository.url    = git://github.com/ajgb/%{lcdist}.git
        repository.web    = http://github.com/ajgb/%{lcdist}
        repository.type   = git

    Bitbucket repository:

        [AutoMetaResources]
        repository.bitbucket = user:ajgb

        # same as
        [MetaResources]
        repository.url    = git://bitbucket.org:ajgb/%{lcdist}.git
        repository.web    = https://bitbucket.org/ajgb/%{lcdist}
        repository.type   = git

    Git Moose repository:

        [AutoMetaResources]
        repository.gitmo = 1

        # same as
        [MetaResources]
        repository.url    = git://git.moose.perl.org/%{dist}.git
        repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo/%{dist}.git;a=summary
        repository.type   = git

    Catalyst Subversion repository:

        [AutoMetaResources]
        repository.catsvn = 1

        # same as
        [MetaResources]
        repository.url    = http://dev.catalyst.perl.org/repos/Catalyst/%{dist}/
        repository.web    = http://dev.catalystframework.org/svnweb/Catalyst/browse/%{dist}
        repository.type   = svn

    Shadowcat's Git repositories:

        [AutoMetaResources]
        repository.catagits = 1

        # same as
        [MetaResources]
        repository.url    = git://git.shadowcat.co.uk/catagits/%{dist}.git
        repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits/%{dist}.git;a=summary
        repository.type   = git

    and

        [AutoMetaResources]
        repository.p5sagit = 1

        # same as
        [MetaResources]
        repository.url    = git://git.shadowcat.co.uk/p5sagit/%{dist}.git
        repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/%{dist}.git;a=summary
        repository.type   = git

    and

        [AutoMetaResources]
        repository.dbsrgits = 1

        # same as
        [MetaResources]
        repository.url    = git://git.shadowcat.co.uk/dbsrgits/%{dist}.git
        repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/%{dist}.git;a=summary
        repository.type   = git

  OTHER
        [AutoMetaResources]
        homepage = https://metacpan.org/release/%{dist}

    You are free to pass other valid metadata options to be included as
    resources. Values can contain following variables:

    *%{dist}*
        Name of the distribution

    *%{lcdist}*
        Name of the distribution (lowercase)

AUTHOR
    Alex J. G. Burzyński <ajgb@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2013 by Alex J. G. Burzyński
    <ajgb@cpan.org>.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.