1Module::Install::GithubUMseetra(C3o)ntributed Perl DocumMeondtualtei:o:nInstall::GithubMeta(3)
2
3
4

NAME

6       Module::Install::GithubMeta - A Module::Install extension to include
7       GitHub meta information in META.yml
8

SYNOPSIS

10         # In Makefile.PL
11
12         use inc::Module::Install;
13         githubmeta;
14
15       The "repository" and "homepage" meta in "META.yml" will be set
16       accordingly.
17

DESCRIPTION

19       Module::Install::GithubMeta is a Module::Install extension to include
20       GitHub <http://github.com> meta information in "META.yml".
21
22       It automatically detects if the distribution directory is under "git"
23       version control and whether the "origin" is a GitHub repository and
24       will set the "repository" and "homepage" meta in "META.yml" to the
25       appropriate URLs for GitHub.
26

COMMANDS

28       This plugin adds the following Module::Install command:
29
30       "githubmeta"
31           Does nothing on the user-side. On the author-side it will auto-
32           detect if the directory is under "git" version control and whether
33           the "origin" is a GitHub repository. Will set "repository" to the
34           public clone URL and "homepage" to the http GitHub link for the
35           repository.
36
37           You may optionally provide the remote to query, this defaults to
38           "origin" if not specified.
39
40           You may override the "homepage" setting by using the
41           Module::Install "homepage" command prior to calling this command.
42
43             use inc::Module::Install;
44             homepage 'http://mymoduleshomepage.com/';
45             githubmeta;
46

AUTHOR

48       Chris "BinGOs" Williams
49
50       Based on code from Module::Install::Repository by Tatsuhiko Miyagawa
51

LICENSE

53       Copyright © Chris Williams and Tatsuhiko Miyagawa
54
55       This module may be used, modified, and distributed under the same terms
56       as Perl itself. Please see the license that came with your Perl
57       distribution for details.
58

SEE ALSO

60       Module::Install
61
62
63
64perl v5.30.1                      2020-01-30    Module::Install::GithubMeta(3)
Impressum