NAME

Dist::Zilla::Role::Git::Repo - Provide repository information for Git plugins

VERSION

version 2.049

DESCRIPTION

This role is used within the Git plugins to get information about the repository structure, and to create a Git::Wrapper object.

ATTRIBUTES

repo_root

The repository root, either as a full path or relative to the distribution root. The default is the distribution root ("$zilla-"root>).

METHODS

current_git_branch

  $branch = $plugin->current_git_branch;

The current branch in the repository, or "undef" if the repository has a detached HEAD. Note: This value is cached; it will not be updated if the branch is changed during the run.

git

  $git = $plugin->git;

This method returns a Git::Wrapper object for the "repo_root" directory, constructing one if necessary. The object is shared between all plugins that consume this role (if they have the same "repo_root").

SUPPORT

Bugs may be submitted through the RT bug tracker <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>.

AUTHOR

Jerome Quelin

COPYRIGHT AND LICENCE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.