Dist::...g::Git(3pm)

💖 Dist::...g::Git(3pm) — the manual page, but make it cute 💖

okay bestie, buckle up, we're reading the <pink>Dist::...g::Git(3pm)</pink> manpage together and honestly? it's giving "small file, big feelings". it's a User Contributed Perl Documentation situation. let's get into it 🫶

---

✨ NAME ✨

Dist::Zilla::Plugin::Config::Git — a plugin configuration that holds all your settings for a Git repo 💅

---

🌸 SYNOPSIS 🌸

[Config::Git / Git::main]
remote        = origin
local_branch  = master
remote_branch = master
allow_dirty   = dist.ini
allow_dirty   = README
allow_dirty   = qr{\w+\.ini}
changelog     = Changes

[Git::CheckFor::CorrectBranch]
git_config = Git::main

[@Git]
git_config = Git::main

; etc.

no cap, that's the whole vibe right there 💖

---

🦋 DESCRIPTION 🦋

okay so this is a configuration plugin for Git repo + branch info. a configuration plugin is like... sort of a Stash, but lowkey better suited for intra-plugin data sharing, and it uses distro data, not user data. slay ✨

why would you even use this, bestie? because it hands a standard set of info to your other Git plugins, super easily — especially when your repo data is non-standard, or when you need more than one set of data. main character energy for your distro config fr fr 👑

---

💅 OPTIONS 💅

remote

Name of the remote repo, in standard Git repo format (refspec or git URL).

Default is "origin".

local_branch

Name of the local branch name.

Default is "master".

remote_branch

Name of the remote branch name.

Default is "master".

allow_dirty

Filenames of files in the local repo that are allowed to have modifications prior to a write action, like a commit. you can have multiple lines, bestie — go off. any strings in standard qr notation get interpreted as regular expressions 🧚

Default is "dist.ini" and whatever changelog is set to.

changelog

Name of your change log.

Default is "Changes".

---

🎀 ACKNOWLEDGEMENTS 🎀

• Kent Fredric and Karen Etheridge for implementation discussion 💬
• Graham Knop for continuous code reviews 👑 iconic behaviour

---

🌈 AVAILABILITY 🌈

the project homepage is <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git>.

the latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). visit <http://www.perl.com/CPAN/> to find a CPAN site near you, or see <https://metacpan.org/module/Dist::Zilla::Plugin::Config::Git/> ⭐

---

🫶 SUPPORT 🫶

💬 Internet Relay Chat

you can get live help by using IRC ( Internet Relay Chat ). if you don't know what IRC is, please read this excellent guide: <http://en.wikipedia.org/wiki/Internet_Relay_Chat>. please be courteous and patient when talking to us, because we might be busy or sleeping 😭 !!! you can join these networks/channels and get help:

• irc.perl.org

you can connect to the server at 'irc.perl.org' and talk to this person for help: SineSwiper.

🐛 Bugs / Feature Requests

please report any bugs or feature requests via <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git/issues> 🍓

---

👑 AUTHOR 👑

Brendan Byrd <BBYRD@CPAN.org>

---

⭐ CONTRIBUTOR ⭐

Graham Knop <haarg@haarg.org>

---

💜 COPYRIGHT AND LICENSE 💜

this software is Copyright (c) 2013 by Brendan Byrd.

this is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

---

💀 lowkey important reminder: that's the license, bestie. Artistic License 2.0, GPL Compatible. respect it 🙈

okay that's the whole page, you ate that 💅✨ — this was Dist::...g::Git(3pm) from perl v5.34.0, dated 2022-06-16. mwah, go commit something 🎀💖