.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Dist::Zilla::Plugin::Repository 3pm" .TH Dist::Zilla::Plugin::Repository 3pm "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Dist::Zilla::Plugin::Repository \- Automatically sets repository URL from svn/svk/Git checkout for Dist::Zilla .SH "VERSION" .IX Header "VERSION" version 0.24 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # dist.ini \& [Repository] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The code is mostly a copy-paste of Module::Install::Repository .SS "\s-1ATTRIBUTES\s0" .IX Subsection "ATTRIBUTES" .IP "\(bu" 4 git_remote .Sp This is the name of the remote to use for the public repository (if you use Git). By default, unsurprisingly, to \fIorigin\fR. .IP "\(bu" 4 github_http .Sp \&\fBThis attribute is deprecated.\fR If the remote is a GitHub repository, list only the https url (https://github.com/fayland/dist\-zilla\-plugin\-repository) and not the actual clonable url (git://github.com/fayland/dist\-zilla\-plugin\-repository.git). This used to default to true, but as of 0.16 it defaults to false. .Sp The \s-1CPAN\s0 Meta 2 spec defines separate keys for the clonable \f(CW\*(C`url\*(C'\fR and web front-end \f(CW\*(C`web\*(C'\fR. The Meta 1 specs allowed only 1 \s-1URL.\s0 If you set \f(CW\*(C`github_http\*(C'\fR to true, the \f(CW\*(C`url\*(C'\fR key will be removed from the v2 metadata, and the v1 metadata will then use the \f(CW\*(C`web\*(C'\fR key. .Sp Instead of setting \f(CW\*(C`github_http\*(C'\fR, you should use the MetaJSON plugin to include a v2 \s-1META\s0.json file with both URLs. .IP "\(bu" 4 repository .Sp You can set this attribute if you want a specific repository instead of the plugin to auto-identify your repository. .Sp An example would be if you're releasing a module from your fork, and you don't want it to identify your fork, so you can specify the repository explicitly. .Sp In the Meta 2 spec, this is the \f(CW\*(C`url\*(C'\fR key. .IP "\(bu" 4 type .Sp This should be the (lower-case) name of the most common program used to work with the repository, e.g. git, svn, cvs, darcs, bzr or hg. It's normally determined automatically, but you can override it. .IP "\(bu" 4 web .Sp This is a \s-1URL\s0 pointing to a human-usable web front-end for the repository. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Fayland Lam .IP "\(bu" 4 Ricardo \s-1SIGNES\s0 .IP "\(bu" 4 Moritz Onken .IP "\(bu" 4 Christopher J. Madsen .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2018 by Fayland Lam, Ricardo \s-1SIGNES,\s0 Moritz Onken, Christopher J. Madsen. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.