1Dist::Zilla::Plugin::CoUnsfeirg:C:oGnittr(i3b)uted PerlDDiosctu:m:eZnitlaltai:o:nPlugin::Config::Git(3)
2
3
4
6 Dist::Zilla::Plugin::Config::Git - Plugin configuration containing
7 settings for a Git repo
8
10 [Config::Git / Git::main]
11 remote = origin
12 local_branch = master
13 remote_branch = master
14 allow_dirty = dist.ini
15 allow_dirty = README
16 allow_dirty = qr{\w+\.ini}
17 changelog = Changes
18
19 [Git::CheckFor::CorrectBranch]
20 git_config = Git::main
21
22 [@Git]
23 git_config = Git::main
24
25 ; etc.
26
28 This is a configuration plugin for Git repo/branch information. A
29 configuration plugin is sort of like a Stash, but is better suited for
30 intra-plugin data sharing, using distro (not user) data.
31
32 Why use this? To provide a standard set of information to other Git
33 plugins easily, especially if the repo data is non-standard, or if you
34 need more than one set of data.
35
37 remote
38 Name of the remote repo, in standard Git repo format (refspec or git
39 URL).
40
41 Default is "origin".
42
43 local_branch
44 Name of the local branch name.
45
46 Default is "master".
47
48 remote_branch
49 Name of the remote branch name.
50
51 Default is "master".
52
53 allow_dirty
54 Filenames of files in the local repo that are allowed to have
55 modifications prior to a write action, such as a commit. Multiple
56 lines are allowed. Any strings in standard "qr" notation are
57 interpreted as regular expressions.
58
59 Default is "dist.ini" and whatever changelog is set to.
60
61 changelog
62 Name of your change log.
63
64 Default is "Changes".
65
67 Kent Fredric and Karen Etheridge for implementation discussion. Graham
68 Knop for continuous code reviews.
69
71 The project homepage is
72 <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git>.
73
74 The latest version of this module is available from the Comprehensive
75 Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find
76 a CPAN site near you, or see
77 <https://metacpan.org/module/Dist::Zilla::Plugin::Config::Git/>.
78
80 Internet Relay Chat
81 You can get live help by using IRC ( Internet Relay Chat ). If you
82 don't know what IRC is, please read this excellent guide:
83 <http://en.wikipedia.org/wiki/Internet_Relay_Chat>. Please be courteous
84 and patient when talking to us, as we might be busy or sleeping! You
85 can join those networks/channels and get help:
86
87 • irc.perl.org
88
89 You can connect to the server at 'irc.perl.org' and talk to this
90 person for help: SineSwiper.
91
92 Bugs / Feature Requests
93 Please report any bugs or feature requests via
94 <https://github.com/SineSwiper/Dist-Zilla-Plugin-Config-Git/issues>.
95
97 Brendan Byrd <BBYRD@CPAN.org>
98
100 Graham Knop <haarg@haarg.org>
101
103 This software is Copyright (c) 2013 by Brendan Byrd.
104
105 This is free software, licensed under:
106
107 The Artistic License 2.0 (GPL Compatible)
108
109
110
111perl v5.36.0 2023-01-20Dist::Zilla::Plugin::Config::Git(3)