1Dist::Zilla::Plugin::GiUtsheurbMCeotnat(r3i)buted Perl DDoicsutm:e:nZtialtliao:n:Plugin::GithubMeta(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::GithubMeta - Automatically include GitHub meta
7       information in META.yml
8

VERSION

10       version 0.58
11

SYNOPSIS

13         # in dist.ini
14
15         [GithubMeta]
16
17         # to override the homepage
18
19         [GithubMeta]
20         homepage = http://some.sort.of.url/project/
21
22         # to override the github remote repo (defaults to 'origin')
23         [GithubMeta]
24         remote = github
25

DESCRIPTION

27       Dist::Zilla::Plugin::GithubMeta is a Dist::Zilla plugin to include
28       GitHub <https://github.com> meta information in "META.yml" and
29       "META.json".
30
31       It automatically detects if the distribution directory is under "git"
32       version control and whether the "origin" is a GitHub repository and
33       will set the "repository" and "homepage" meta in "META.yml" to the
34       appropriate URLs for GitHub.
35
36       Based on Module::Install::GithubMeta which was based on
37       Module::Install::Repository by Tatsuhiko Miyagawa
38
39   ATTRIBUTES
40       "remote"
41           The GitHub remote repo can be overridden with this attribute. If
42           not provided, it defaults to "origin".  You can provide multiple
43           remotes to inspect.  The first one that looks like a GitHub remote
44           is used.
45
46       "homepage"
47           You may override the "homepage" setting by specifying this
48           attribute. This should be a valid URL as understood by
49           MooseX::Types::URI.
50
51       "issues"
52           If true, a bugtracker URL will be added to the distribution
53           metadata for the project's GitHub issues page.
54
55       "user"
56           If given, the "user" parameter overrides the username found in the
57           GitHub repository URL.  This is useful if many people might release
58           from their own workstations, but the distribution metadata should
59           always point to one user's repo.
60
61       "repo"
62           If give, the "repo" parameter overrides the repository name found
63           in the GitHub repository URL.
64
65   METHODS
66       "metadata"
67           Required by Dist::Zilla::Role::MetaProvider
68

SEE ALSO

70       Dist::Zilla
71

AUTHORS

73       ·   Chris Williams <chris@bingosnet.co.uk>
74
75       ·   Ricardo SIGNES <rjbs@cpan.org>
76

78       This software is copyright (c) 2018 by Chris Williams, Tatsuhiko
79       Miyagawa and Ricardo SIGNES.
80
81       This is free software; you can redistribute it and/or modify it under
82       the same terms as the Perl 5 programming language system itself.
83
84
85
86perl v5.32.0                      2020-07-28Dist::Zilla::Plugin::GithubMeta(3)
Impressum