Debian Codegraph @

README

raw
1 NAME
2
3 Dist::Zilla::Plugin::GithubMeta - Automatically include GitHub meta
4 information in META.yml
5
6 VERSION
7
8 version 0.58
9
10 SYNOPSIS
11
12 # in dist.ini
13
14 [GithubMeta]
15
16 # to override the homepage
17
18 [GithubMeta]
19 homepage = http://some.sort.of.url/project/
20
21 # to override the github remote repo (defaults to 'origin')
22 [GithubMeta]
23 remote = github
24
25 DESCRIPTION
26
27 Dist::Zilla::Plugin::GithubMeta is a Dist::Zilla plugin to include
28 GitHub https://github.com meta information in META.yml and META.json.
29
30 It automatically detects if the distribution directory is under git
31 version control and whether the origin is a GitHub repository and will
32 set the repository and homepage meta in META.yml to the appropriate
33 URLs for GitHub.
34
35 Based on Module::Install::GithubMeta which was based on
36 Module::Install::Repository by Tatsuhiko Miyagawa
37
38 ATTRIBUTES
39
40 remote
41
42 The GitHub remote repo can be overridden with this attribute. If not
43 provided, it defaults to origin. You can provide multiple remotes to
44 inspect. The first one that looks like a GitHub remote is used.
45
46 homepage
47
48 You may override the homepage setting by specifying this attribute.
49 This should be a valid URL as understood by MooseX::Types::URI.
50
51 issues
52
53 If true, a bugtracker URL will be added to the distribution metadata
54 for the project's GitHub issues page.
55
56 user
57
58 If given, the user parameter overrides the username found in the
59 GitHub repository URL. This is useful if many people might release
60 from their own workstations, but the distribution metadata should
61 always point to one user's repo.
62
63 repo
64
65 If give, the repo parameter overrides the repository name found in
66 the GitHub repository URL.
67
68 METHODS
69
70 metadata
71
72 Required by Dist::Zilla::Role::MetaProvider
73
74 SEE ALSO
75
76 Dist::Zilla
77
78 AUTHORS
79
80 * Chris Williams <[email protected]>
81
82 * Ricardo SIGNES <[email protected]>
83
84 COPYRIGHT AND LICENSE
85
86 This software is copyright (c) 2018 by Chris Williams, Tatsuhiko
87 Miyagawa and Ricardo SIGNES.
88
89 This is free software; you can redistribute it and/or modify it under
90 the same terms as the Perl 5 programming language system itself.
91