From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

KENTNL / Dist-Zilla-Plugin-Git-Remote-Check-0.1.2 / lib / Dist / Zilla / Role / Git / Remote / Update.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
—
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

              
use strict;
use warnings;
package Dist::Zilla::Role::Git::Remote::Update;
BEGIN {
  $Dist::Zilla::Role::Git::Remote::Update::AUTHORITY = 'cpan:KENTNL';
}
{
  $Dist::Zilla::Role::Git::Remote::Update::VERSION = '0.1.2';
}
# FILENAME: Update.pm
# CREATED: 12/10/11 21:44:42 by Kent Fredric (kentnl) <kentfredric@gmail.com>
# ABSTRACT: Update tracking data for a remote repository
use Moose::Role;
requires 'git';
requires 'remote';
requires 'log';
has 'do_update' => ( isa => 'Bool', is => 'rw', default => 1 );
sub remote_update {
  my $self = shift;
  return unless $self->do_update;
  my $remote = $self->remote;
  $self->log( [ q[Updating remote '%s'], $remote ] );
  my (@out) = $self->git->remote( '--verbose', 'update', $remote );
  $self->log_debug("[git] $_") for @out;
  return 1;
}
no Moose::Role;
1;
__END__
=pod
=head1 NAME
Dist::Zilla::Role::Git::Remote::Update - Update tracking data for a remote repository
=head1 VERSION
version 0.1.2
=head1 PARAMETERS
=head2 C<do_update>
Boolean: Specify whether or not the L</do_update> method does anything.
Defaults to 1 ( true ), and setting it to a false value will disable updating.
=head1 METHODS
=head2 C<do_update>
Boolean: Returns whether the consuming plugin should perform updates.
Normally returns 1 ( true ) unless specified otherwise.
=head2 C<remote_update>
Calls C<git remote update $remote> when triggered, if C<do_update> is true.
=head1 REQUIRED METHODS
=head2 C<git>
Must return a L<Git::Wrapper> or compatible instance.
Available from:
=over 4
=item * L<Dist::Zilla::Role::Git::LocalRepository>
=back
=head2 C<remote>
Must return a String value representing a remote name ( as displayed in C<git remote> ).
Available from:
=over 4
=item * L<Dist::Zilla::Role::Git::Remote>
=back
=head2 C<log>
Expected to take parameters as follows:
  ->log( [ 'FormatString %s' , $formatargs ] )
Available from:
=over 4
=item * L<Dist::Zilla::Role::Plugin>
=back
=head1 AUTHOR
Kent Fredric <kentnl@cpan.org>
=head1 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.
=cut