Dist::...::Check(3pm)

✨ NAME ✨

Dist::Zilla::Plugin::Git::Check — bestie, this one checks your git repo before you release 💅

(and yeah, that's Dist::...::Check(3pm) in the corner of your terminal, she's just shy)

---

🎀 VERSION 🎀

version 2.052 — she's grown up, we stan 🫶

---

🌸 SYNOPSIS 🌸

okay so in your dist.ini, literally just:

[Git::Check]
allow_dirty = dist.ini
allow_dirty = README
changelog = Changes      ; this is the default
build_warnings = 0       ; this is the default
untracked_files = die    ; default value (can also be "warn" or "ignore")

periodt. that's the whole vibe 🦋

---

💖 DESCRIPTION 💖

not me writing a whole plugin whose only job is making sure your Git repo is in a clean state before you release 😭 because she IS that girl and she takes no nonsense.

so before releasing, she runs these checks, in order:

• there should be no files in the index (that's the staged copy, iykyk) 🧚
• there should be no untracked files in the working copy 👀
• the working copy should be clean. the files listed in allow_dirty can be modified locally, though — those are the exceptions, the VIP list 🎟️

if those conditions are NOT met, the plugin will die, and the release will thus be aborted. ngl this is the good kind of dramatic — it lets you fix the problems before continuing instead of posting a garbage release to CPAN 💀

the plugin accepts the following options:

• changelog — the name of your changelog file. defaults to Changes.
• allow_dirty — a file that is allowed to have local modifications. this option may appear multiple times. the default list is dist.ini and the changelog file given by changelog. you can use allow_dirty = to prohibit all local modifications 🚫
• allow_dirty_match — works the same as allow_dirty, but matching as a regular expression instead of an exact filename. she's flexible like that ✨
• build_warnings — if 1, perform the same checks after every build, but as warnings, not errors. defaults to 0.
• untracked_files — indicates what to do if there are untracked files. must be either die (the default), warn, or ignore. warn lists the untracked files, while ignore only prints the total number of untracked files. pick your fighter 👑

---

🫶 SUPPORT 🫶

got bugs? she wants to hear about them fr fr —

bugs may be submitted through the RT bug tracker at https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Git (or bug-Dist-Zilla-Plugin-Git@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Git@rt.cpan.org>) 🐛

there is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list 📬

there is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org <irc://irc.perl.org/#distzilla> 💬

come hang, the group chat is open 🫂

---

👑 AUTHOR 👑

Jerome Quelin — the icon, the legend, the main character who gave us this plugin 🌟

---

🌈 COPYRIGHT AND LICENCE 🌈

this software is copyright (c) 2009 by Jerome Quelin.

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 💅

---

okay bye bestie, this was perl v5.40.1, dated 2025-09-29 — go forth and release clean ✨🦋💜