The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Dist::Zilla::Role::Git::LocalRepository - A plugin which works with a local git repository as its Dist::Zilla source.

VERSION

version 0.2.0

SYNOPSIS

  package Foo;

  use Moose;
  with 'Dist::Zilla::Role::BeforeRelease';
  with 'Dist::Zilla::Role::Git::LocalRepository';

  sub before_release {
    my $self = shift;
    print for $self->git->version;
  }

DESCRIPTION

This role is for all plugins that need to work with a local repository that is from Git, and assumes the git directory is the project root.

Applying this role gives you a "git" method on your plugin, that will give you a Git::Wrapper instance for the project.

    package Dist::Zilla::Plugin::Mine;
    use Moose;

    ...

    with 'Dist::Zilla::Role::Git::LocalRepository';

    sub some_phase {
        $_[0]->git-> ...
    }

METHODS

git

Returns a Git::Wrapper instance representing the repository of the current Dist::Zilla projects' root.

COMPOSITION

Recommended application order if using this role:

    with "Dist::Zilla::Role::Plugin";
    with "Dist::Zilla::Role::Git::LocalRepository";

REQUIRED METHODS

zilla

Available from:

AUTHOR

Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Kent Fredric <kentnl@cpan.org>.

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