Dist::...ository(3pm)

📦
version 0.25 · 3 versions
, in ubuntu stonking

💖 NAME 💖

okay so bestie, welcome to Dist::Zilla::Plugin::Repository — she's the queen who automatically sets your repository URL by peeking at your svn / svk / Git checkout, all for Dist::Zilla. yes, she does the annoying part for you, we love that for her ✨

🌸 VERSION 🌸

version 0.25 — she's giving seasoned, she's giving mature, she's giving iconic

✨ SYNOPSIS ✨

so like, this is all you need in your dist.ini, fr fr:

# dist.ini
[Repository]

that's it. that's the whole vibe. 🎀

🦋 DESCRIPTION 🦋

ngl the code is mostly a copy-paste of Module::Install::Repository. she said "borrowed, not stolen" and honestly? valid. 💅

🌈 ATTRIBUTES 🌈

  • git_remote — this is the name of the remote to use for the public repository (like, if you're on Git). by default — and this is gonna shock literally no one — it's origin. no cap.
  • github_http — ⚠️ bestie, this attribute is deprecated, okay, we're not mad we're just disappointed. if the remote is a GitHub repository, you'd list only the https url (https://github.com/fayland/dist-zilla-plugin-repository) and not the actual clonable url (git://github.com/fayland/dist-zilla-plugin-repository.git). this used to default to true, but as of 0.16 it defaults to false.

the CPAN Meta 2 spec defines separate keys for the clonable "url" and the web front-end "web". the Meta 1 specs allowed only 1 URL. so if you set "github_http" to true, the "url" key will be removed from the v2 metadata, and the v1 metadata will then use the "web" key. it's giving messy, honestly.

instead of setting "github_http", you should use the MetaJSON plugin to include a v2 META.json file with both URLs. do that. be that girl. 🫶

  • repository — you can set this attribute if you want a specific repository instead of letting the plugin auto-identify your repository. an example would be if you're releasing a module from your fork, and you don't want it to identify your fork, so you specify the repository explicitly. main character move. in the Meta 2 spec, this is the "url" key. 🔥
  • type — this should be the (lower-case) name of the most common program used to work with the repository, e.g. git, svn, cvs, darcs, bzr, or hg. it's normally determined automatically, but you can override it if you wanna be like that. 😌
  • web — this is a URL pointing to a human-usable web front-end for the repository. yes, a URL that real humans can actually click on. we love accessibility. 💜

👑 AUTHORS 👑

the literal legends who made this happen, no notes:

  • Fayland Lam <fayland@gmail.com>
  • Ricardo SIGNES <rjbs@cpan.org>
  • Moritz Onken <onken@netcubed.de>
  • Christopher J. Madsen <perl@cjmweb.net>

this software is copyright (c) 2026 by Fayland Lam, Ricardo SIGNES, Moritz Onken, Christopher J. Madsen.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, open source, periodt. 🌈

and that's the whole page, bestie!! 🎀 this was Dist::...ository(3pm) from the User Contributed Perl Documentation, running on perl v5.40.1, dated 2026-05-09 — mwah, go set that repository URL, you got this 💖✨🦋

📦 where this page comes from