1Dist::Zilla::Plugin::GiUts:e:rCoCmomnittr(i3b)uted PerlDDiosctu:m:eZnitlaltai:o:nPlugin::Git::Commit(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::Git::Commit - Commit dirty files
7

VERSION

9       version 2.048
10

SYNOPSIS

12       In your dist.ini:
13
14           [Git::Commit]
15           changelog = Changes      ; this is the default
16

DESCRIPTION

18       Once the release is done, this plugin will record this fact in git by
19       committing changelog and dist.ini. The commit message will be taken
20       from the changelog for this release.  It will include lines between the
21       current version and timestamp and the next non-indented line, except
22       that blank lines at the beginning or end are removed.
23
24       Warning: If you are using Git::Commit in conjunction with the
25       NextRelease plugin, "[NextRelease]" must come before "[Git::Commit]"
26       (or "[@Git]") in your dist.ini or plugin bundle.  Otherwise,
27       Git::Commit will commit the Changes file before NextRelease has updated
28       it.
29
30       The plugin accepts the following options:
31
32       •   changelog - the name of your changelog file. Defaults to Changes.
33
34       •   allow_dirty - a file that will be checked in if it is locally
35           modified.  This option may appear multiple times.  The default list
36           is dist.ini and the changelog file given by "changelog".
37
38       •   allow_dirty_match - works the same as allow_dirty, but matching as
39           a regular expression(s) instead of an exact filename(s).
40
41       •   add_files_in - a path that will have its new files checked in.
42           This option may appear multiple times. This is used to add files
43           generated during build-time to the repository, for example. The
44           default list is empty.
45
46           Note: The files have to be generated between the phases
47           BeforeRelease <-> AfterRelease, and after Git::Check + before
48           Git::Commit.
49
50       •   commit_msg - the commit message to use. Defaults to "v%V%n%n%c",
51           meaning the version number and the list of changes.  The formatting
52           codes are documented under Dist::Zilla::Role::Git::StringFormatter.
53
54       •   time_zone - the time zone to use with %d.  Can be any time zone
55           name accepted by DateTime.  Defaults to "local".
56

METHODS

58   get_commit_message
59       This method returns the commit message.  The default implementation
60       reads the Changes file to get the list of changes in the just-released
61       version.
62

SUPPORT

64       Bugs may be submitted through the RT bug tracker
65       <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-
66       Git> (or bug-Dist-Zilla-Plugin-Git@rt.cpan.org <mailto:bug-Dist-Zilla-
67       Plugin-Git@rt.cpan.org>).
68
69       There is also a mailing list available for users of this distribution,
70       at <http://dzil.org/#mailing-list>.
71
72       There is also an irc channel available for users of this distribution,
73       at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
74

AUTHOR

76       Jerome Quelin
77

79       This software is copyright (c) 2009 by Jerome Quelin.
80
81       This is free software; you can redistribute it and/or modify it under
82       the same terms as the Perl 5 programming language system itself.
83
84
85
86perl v5.34.0                      2021-07-22Dist::Zilla::Plugin::Git::Commit(3)
Impressum