Dist::...hubMeta(3pm)

💖 Dist::Zilla::Plugin::GithubMeta — the manual page but make it iconic 💖

okay bestie, gather round, because this is the <rainbow>Dist::...hubMeta(3pm)</rainbow> page and honestly? it ate. it's a Perl manpage, it lives in the User Contributed Perl Documentation section, and it's about a Dist::Zilla plugin that automatically shoves your GitHub meta info into your dist metadata. slay.

version 0.58 btw. no cap.

---

✨ SYNOPSIS ✨

like, here's the vibe. you just drop this in your dist.ini:

# in dist.ini

[GithubMeta]

want to override the homepage? say less:

# to override the homepage

[GithubMeta]
homepage = http://some.sort.of.url/project/

want to override the github remote repo? (it defaults to 'origin' fyi)

# to override the github remote repo (defaults to 'origin')
[GithubMeta]
remote = github

periodt. 💅

---

🌸 DESCRIPTION 🌸

so Dist::Zilla::Plugin::GithubMeta is a Dist::Zilla plugin whose whole entire job is to include GitHub (that's <https://github.com>, the site, you know the one) meta information inside META.yml and META.json. it's giving "I handle the paperwork so you don't have to."

here's the magic: it automatically peeks at whether your distribution directory is chillin' under git version control, and whether the origin is a GitHub repository, and if so it sets the repository and homepage meta in META.yml to the appropriate URLs for GitHub. like it just knows. iykyk. ✨

it's based on Module::Install::GithubMeta, which was itself based on Module::Install::Repository by Tatsuhiko Miyagawa. generational talent honestly, the lineage is real. 🧬

---

🎀 ATTRIBUTES 🎀

• remote — this is how you override the GitHub remote repo. if you don't give it anything, it lowkey defaults to "origin". and get this — you can actually hand it multiple remotes to inspect, and it'll use the first one that looks like a GitHub remote. iconic behavior. 👑
• homepage — want to override the homepage setting? just specify this attribute, bestie. it should be a valid URL as understood by MooseX::Types::URI, so don't get cute with it.
• issues — if this is true, a bugtracker URL gets added to the distribution metadata, pointing at the project's GitHub issues page. so people know where to yell. 🐛
• user — if you give this, the user parameter overrides the username found in the GitHub repository URL. super useful when lots of people might be releasing from their own workstations, but the distribution metadata should always point to one specific user's repo. one true repo energy. 💖
• repo — if give, the repo parameter overrides the repository name found in the GitHub repository URL. (yes, the original says "if give" and honestly? we're keeping it, it's part of the lore now. 💀)

---

🌈 METHODS 🌈

• metadata — Required by Dist::Zilla::Role::MetaProvider. that's it, that's the whole note. it's required, it does the thing, it's the main character. ⭐

---

👀 SEE ALSO 👀

• Dist::Zilla — the whole ecosystem this lives inside, go read it, it's giving foundational.

---

🫶 AUTHORS 🫶

these absolute legends:

• Chris Williams <chris@bingosnet.co.uk>
• Ricardo SIGNES <rjbs@cpan.org>

---

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2018 by Chris Williams, Tatsuhiko Miyagawa and Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

okay so that's the whole page fr fr, every option, every attribute, every author, all of it. don't skip the fine print, it matters. 🍓

and for the cute sign-off: this beauty is documented as perl v5.36.0, dated 2022-11-20, and yes, it still says Dist::...hubMeta(3pm) at the bottom because truncation is eternal. bye bestie, go ship your dist. 🌸✨🦋