Dist::...Release(3pm)

📦
version 6.000 · 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

Dist::...Release 💅 (the ArchiveRelease glow-up)

okay bestie, so this is a page from the User Contributed Perl Documentation manual set, and it's all about Dist::Zilla::Plugin::ArchiveRelease. We're in the group chat, we're talking tarballs, we're archiving them, it's giving organized queen energy. Let's go ✨

🌸 NAME 🌸

Dist::Zilla::Plugin::ArchiveRelease — literally just: move the release tarball to an archive directory. That's the whole vibe. 🎀

🦋 VERSION 🦋

This doc describes version 6.000 of Dist::Zilla::Plugin::ArchiveRelease, released December 17, 2017, and it shipped as part of Dist-Zilla-Plugins-CJM version 6.000. Vintage but iconic, no cap. 💜

✨ SYNOPSIS ✨

So you drop this into your dist.ini, right? Like this:

[ArchiveRelease]
directory = releases      ; this is the default

and boom, that's it, that's the whole thing 💅

💖 DESCRIPTION 💖

If you include this plugin, the release command will mark the tarball read-only and move it to an archive directory. She's done, she's filed, she's protected. 🫶

You can combine this with another Releaser plugin (like UploadToCPAN, for example) — but hear me out, bestie, this is the important part:

⚠️ It must be the last Releaser in your config. If it isn't, the other Releasers won't be able to find the file being released. That's not a vibe, that's a broken build. 😭

It also acts as a FilePruner, so Dist::Zilla won't be out here scooping your archived releases into future builds. Main character behavior honestly. 👑

🎀 ATTRIBUTES 🎀

🌈 directory

The directory the tarball gets moved into. She may begin with "~" (or "~user") to mean your home directory — or some other user's home directory, if you're being fancy. 🌸

  • Defaults to releases.
  • If the directory doesn't exist yet, it will be created during the BeforeRelease phase. She manifests herself. ✨
  • All files inside this directory will be pruned from the distribution. Every single one. Periodt.

💀 INCOMPATIBILITIES 💀

None reported. Clean. Untouched. Drama-free. 🙈

😭 BUGS AND LIMITATIONS 😭

No bugs have been reported. (We love a low-maintenance fave.) 🍓

🧚 AUTHOR 🧚

Christopher J. Madsen <perl AT cjmweb.net> — the icon who made this. 👑

Please report any bugs or feature requests to <bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org>, or slide in through the web interface at:

http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM

You can follow or contribute to Dist-Zilla-Plugins-CJM's development at:

https://github.com/madsen/dist-zilla-plugins-cjm

This software is copyright (c) 2017 by 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. iykyk 🐪

🔥 DISCLAIMER OF WARRANTY 🔥

okay bestie this next bit is the legal bit, so I'm not touching the wording, I'm just delivering it to you exactly as-is, with love and zero edits:

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

and that's the whole page, bestie 🫶</purl> This one came off the shelf from perl v5.34.0, dated 2022-06-13, filed under Dist::...Release(3pm). Archive your tarballs, stay read-only, and remember: last Releaser or it doesn't count. slay 💅✨

📦 where this page comes from