Dist::Zilla::Plugin::Git::Remote::Update::BeforeBuild(3)

NAME
Dist::Zilla::Plugin::Git::Remote::Update::BeforeBuild - Update a remote with Git before build.

VERSION
version 0.1.2

SYNOPSIS
This Module is mostly intended to be used in conjunction with other things, and won't on its own provide a lot of useful results.

Having this in your configuration will effectively cause git to run "git remote update $remotename" before you build, and remotes don't usually have any impact on things in the rest of DZil-land.

  [Git::Remote::Update::BeforeBuild]
  ; Provided by Dist::Zilla::Role::Git::Remote
  ; String
  ; The name of the remote to update.
  ; Must exist in Git.
  ; default is 'origin'
  remote_name = origin

  ; Provided by Dist::Zilla::Role::Git::Remote::Update
  ; Boolean
  ; turn updating on/off
  ; default is 'on' ( 1 / true )
  do_update = 1

PARAMETERS

  "remote_name"
The name of the repository to use as specified in ".git/config".

Defaults to "origin", which is usually what you want.

  "do_update"
A boolean value that specifies whether or not to execute the update.

Default value is 1 / true.

METHODS

  "before_build"
Updates the "remote" via "remote_update" in Dist::Zilla::Role::Git::Remote::Update, before Building the release.

  "git"
Returns a Git::Wrapper instance for the current Dist::Zilla projects "git" Repository.

  "remote"
Returns a validated remote name. Configured via "remote_name" parameter.

  "remote_update"
Performs "git remote update $remote_name" on "git" for the remote "remote"

ROLES

  "Dist::Zilla::Role::BeforeBuild"
Causes this plugin to be executed during Dist::Zilla's "Before Build" phase. ( "before_build" )

  "Dist::Zilla::Role::Git::LocalRepository"
Provides a "git" method that returns a "Git::Wrapper" instance for the current "Dist::Zilla" project.

  "Dist::Zilla::Role::Git::Remote"
Provides a "remote" method which always returns a validated "remote" name, optionally accepting it being specified manually to something other than "origin" via the parameter "remote_name"

  "Dist::Zilla::Role::Git::Remote::Update"
Provides a "remote_update" method which updates a "remote" in "git"

AUTHOR
Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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.