Module:...thubMeta(3)

πŸ“¦
version 0.30 Β· 4 versions
, in epel 9

πŸ’– NAME πŸ’–

okay bestie, welcome to the Module:...thubMeta(3) page from the user-contributed Perl docs πŸ’– this one is all about Module::Install::GithubMeta β€” a Module::Install extension that includes GitHub meta information in META.yml. That's the name and the one-liner, and it ate ✨

πŸ¦‹ SYNOPSIS πŸ¦‹

Drop this into Makefile.PL:

# In Makefile.PL

use inc::Module::Install;
githubmeta;

Then the repository and homepage meta in META.yml will be set accordingly. slay πŸ’…

🌸 DESCRIPTION 🌸

Module::Install::GithubMeta is a Module::Install extension for including GitHub (http://github.com) meta information in META.yml.

It automatically checks whether the distribution directory is under git version control and whether the origin is a GitHub repository. If it is, it sets the repository and homepage meta in META.yml to the appropriate URLs for GitHub. no cap πŸ”₯

πŸ’€ COMMANDS πŸ’€

This plugin adds this Module::Install command:

πŸ¦‹ githubmeta πŸ¦‹

  • user-side β€” does nothing. literally nothing πŸ™ˆ
  • author-side β€” auto-detects whether the directory is under git version control and whether the origin is a GitHub repository. It sets repository to the public clone URL and homepage to the http GitHub link for the repository.
  • optional remote β€” you can provide the remote to query; if you don't specify one, it defaults to origin.
  • homepage override β€” you can override the homepage setting by using the Module::Install homepage command prior to calling this command.

Example time, bestie:

use inc::Module::Install;
homepage 'http://mymoduleshomepage.com/';
githubmeta;

πŸ‘‘ AUTHOR πŸ‘‘

Chris "BinGOs" Williams

Based on code from Module::Install::Repository by Tatsuhiko Miyagawa

πŸŽ€ LICENSE πŸŽ€

Copyright Β© Chris Williams and Tatsuhiko Miyagawa

This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl distribution for details.

🌈 SEE ALSO 🌈

Module::Install


and that's the page! source/version: perl v5.32.1; date: 2021-12-23 β€” byeee bestie πŸ«ΆπŸ’œ

πŸ“¦ where this page comes from