.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Plugin::GithubMeta 3pm"
.TH Dist::Zilla::Plugin::GithubMeta 3pm "2018-06-20" "perl v5.26.2" "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::GithubMeta \- Automatically include GitHub meta information in META.yml
.SH "VERSION"
.IX Header "VERSION"
version 0.58
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  # in dist.ini
\&
\&  [GithubMeta]
\&
\&  # to override the homepage
\&
\&  [GithubMeta]
\&  homepage = http://some.sort.of.url/project/
\&
\&  # to override the github remote repo (defaults to \*(Aqorigin\*(Aq)
\&  [GithubMeta]
\&  remote = github
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Dist::Zilla::Plugin::GithubMeta is a Dist::Zilla plugin to include GitHub <https://github.com> meta
information in \f(CW\*(C`META.yml\*(C'\fR and \f(CW\*(C`META.json\*(C'\fR.
.PP
It automatically detects if the distribution directory is under \f(CW\*(C`git\*(C'\fR version control and whether the
\&\f(CW\*(C`origin\*(C'\fR is a GitHub repository and will set the \f(CW\*(C`repository\*(C'\fR and \f(CW\*(C`homepage\*(C'\fR meta in \f(CW\*(C`META.yml\*(C'\fR to the
appropriate URLs for GitHub.
.PP
Based on Module::Install::GithubMeta which was based on
Module::Install::Repository by Tatsuhiko Miyagawa
.SS "\s-1ATTRIBUTES\s0"
.IX Subsection "ATTRIBUTES"
.ie n .IP """remote""" 4
.el .IP "\f(CWremote\fR" 4
.IX Item "remote"
The GitHub remote repo can be overridden with this attribute. If not
provided, it defaults to \f(CW\*(C`origin\*(C'\fR.  You can provide multiple remotes to
inspect.  The first one that looks like a GitHub remote is used.
.ie n .IP """homepage""" 4
.el .IP "\f(CWhomepage\fR" 4
.IX Item "homepage"
You may override the \f(CW\*(C`homepage\*(C'\fR setting by specifying this attribute. This
should be a valid \s-1URL\s0 as understood by MooseX::Types::URI.
.ie n .IP """issues""" 4
.el .IP "\f(CWissues\fR" 4
.IX Item "issues"
If true, a bugtracker \s-1URL\s0 will be added to the distribution metadata for the
project's GitHub issues page.
.ie n .IP """user""" 4
.el .IP "\f(CWuser\fR" 4
.IX Item "user"
If given, the \f(CW\*(C`user\*(C'\fR parameter overrides the username found in the GitHub
repository \s-1URL.\s0  This is useful if many people might release from their own
workstations, but the distribution metadata should always point to one user's
repo.
.ie n .IP """repo""" 4
.el .IP "\f(CWrepo\fR" 4
.IX Item "repo"
If give, the \f(CW\*(C`repo\*(C'\fR parameter overrides the repository name found in the
GitHub repository \s-1URL.\s0
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.ie n .IP """metadata""" 4
.el .IP "\f(CWmetadata\fR" 4
.IX Item "metadata"
Required by Dist::Zilla::Role::MetaProvider
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Dist::Zilla
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Chris Williams <chris@bingosnet.co.uk>
.IP "\(bu" 4
Ricardo \s-1SIGNES\s0 <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Chris Williams, Tatsuhiko Miyagawa and Ricardo \s-1SIGNES.\s0
.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.