The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

KENTNL / Dist-Zilla-Plugin-Git-Remote-Check-0.1.2 / lib / Dist / Zilla / Plugin / 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
136
137
138
139
140
141
142
143

              
use strict;
use warnings;
package Dist::Zilla::Plugin::Git::Remote::Update;
BEGIN {
  $Dist::Zilla::Plugin::Git::Remote::Update::AUTHORITY = 'cpan:KENTNL';
}
{
  $Dist::Zilla::Plugin::Git::Remote::Update::VERSION = '0.1.2';
}
# FILENAME: Update.pm
# CREATED: 13/10/11 05:17:02 by Kent Fredric (kentnl) <kentfredric@gmail.com>
# ABSTRACT: Update a remote with Git before release.
use Moose;
with 'Dist::Zilla::Role::BeforeRelease';
sub before_release {
  my $self = shift;
  $self->remote_update;
  return 1;
}
with 'Dist::Zilla::Role::Git::LocalRepository';
with 'Dist::Zilla::Role::Git::Remote';
with 'Dist::Zilla::Role::Git::Remote::Update';
no Moose;
__PACKAGE__->meta->make_immutable;
1;
__END__
=pod
=head1 NAME
Dist::Zilla::Plugin::Git::Remote::Update - Update a remote with Git before release.
=head1 VERSION
version 0.1.2
=head1 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 C<git remote update $remotename>
before you release, and remotes don't usually have any impact on things in the rest of DZil-land.
  [Git::Remote::Update]
  ; 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
=head1 PARAMETERS
=head2 C<remote_name>
The name of the repository to use as specified in C<.git/config>.
Defaults to C<origin>, which is usually what you want.
=head2 C<do_update>
A boolean value that specifies whether or not to execute the update.
Default value is C<1> / true.
=head1 METHODS
=head2 C<before_release>
Updates the L</remote> via L<Dist::Zilla::Role::Git::Remote::Update/remote_update>, before releasing.
=head2 C<git>
Returns a L<Git::Wrapper> instance for the current L<Dist::Zilla> projects
C<git> Repository.
=head2 C<remote>
Returns a validated remote name. Configured via L</remote_name> parameter.
=head2 C<remote_update>
Performs C<git remote update $remote_name> on L</git> for the remote L</remote>
=head1 ROLES
=head2 C<Dist::Zilla::Role::BeforeRelease>
Causes this plugin to be executed during L<Dist::Zilla>'s "Before Release" phase.
( L</before_release> )
=head2 C<Dist::Zilla::Role::Git::LocalRepository>
Provides a L</git> method that returns a C<Git::Wrapper> instance for the
current C<Dist::Zilla> project.
=head2 C<Dist::Zilla::Role::Git::Remote>
Provides a L</remote> method which always returns a validated C<remote> name,
optionally accepting it being specified manually to something other than
C<origin> via the parameter L</remote_name>
=head2 C<Dist::Zilla::Role::Git::Remote::Update>
Provides a L</remote_update> method which updates a L</remote> in L</git>
=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