logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Dist::Zilla::Plugin::Config::Git - Plugin configuration containing settings for a Git repo

Acknowledgements

       Kent Fredric and Karen Etheridge for implementation discussion.  Graham Knop for continuous code reviews.

Author

       Brendan Byrd <BBYRD@CPAN.org>

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/>.

Contributor

       Graham Knop <haarg@haarg.org>

Description

       This is a configuration plugin for Git repo/branch information.  A configuration plugin is sort of like a
       Stash, but is better suited for intra-plugin data sharing, using distro (not user) data.

       Why use this?  To provide a standard set of information to other Git plugins easily, especially if the
       repo data is non-standard, or if you need more than one set of data.

Name

       Dist::Zilla::Plugin::Config::Git - Plugin configuration containing settings for a Git repo

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, such
       as a commit.  Multiple lines are allowed.  Any strings in standard "qr" notation are interpreted as
       regular expressions.

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

   changelog
       Name of your change log.

       Default is "Changes".

Support

InternetRelayChat
       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, as we might be busy or sleeping! You can join those 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/FeatureRequests
       Please          report          any          bugs         or         feature         requests         via
       <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git/issues>.

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.

See Also