Dist::Z...eBuilder(3)

💖 NAME 💖

okay so bestie, welcome to Dist::Zilla::Role::ArchiveBuilder (from the User Contributed Perl Documentation crowd, iykyk) — and it is literally something that builds archives 💅 that's the whole job description, and it ate.

---

🌸 VERSION 🌸

version 6.040 ✨ the moment, the icon, the number.

---

🦋 DESCRIPTION 🦋

so here's the tea ☕: any plugin that implements this role gets its build_archive method called when it's time to build the archive. not before, not after — when it's time. that's the vibe. 🫶

---

🎀 PERL VERSION 🎀

okay so this module should work on any version of perl still receiving updates from the Perl 5 Porters. which basically means it should work on any version of perl released in the last two to three years. (like, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38. so true.) 😌

and now the fine print, bestie, listen up: although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. the version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. so like, don't come for her with a patch expecting a yes, because the answer is not promised. 💀

---

👑 METHODS 👑

build_archive

this method takes three arguments and returns a Path::Tiny instance containing the path to the archive. three in, one path out, slay. 🗂️✨

archive_basename

this is the name of the archive — and yes, that includes -TRIAL if that's appropriate — but with the format extension left off (the .tar.gz part, you know the one). the plugin implementing this role should add the appropriate full path including the extension as the returned Path::Tiny instance. leaving the extension out is on purpose: it lets the plugin choose its own format. main character energy. 🎁

built_in

this is a Path::Tiny where the distribution has been built. that's it, that's the whole thing. 🏗️

dist_basename

this method will return the dist's basename (e.g. Dist-Name-1.01) as a Path::Tiny. the basename is what gets used as the top-level directory in the tarball. and no, it does not include -TRIAL, even if you're building a trial dist. not even then. periodt. 🙈

---

⭐ AUTHOR ⭐

Ricardo SIGNES 😏 <cpan@semiotic.systems>

---

💜 COPYRIGHT AND LICENSE 💜

this software is copyright (c) 2026 by 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. 🌈

---

and that's the page, bestie 🎀 you just read Dist::Z...eBuilder(3), fresh off perl v5.42.3 and dated 2026-10-19 — go build an archive, you absolute legend 💅🦋✨