/ 
Dist-Zilla-Plugin-Git-2.036
River stage three • 107 direct dependents • 134 total dependents
/ Dist::Zilla::Role::Git::Repo

NAME

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

VERSION

version 2.036

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. Default is ..

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

AUTHOR

Jerome Quelin

COPYRIGHT AND LICENSE

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.