1Dist::Zilla::Plugin::NeUxsteRrelCeoanster(i3b)uted PerlDDiosctu:m:eZnitlaltai:o:nPlugin::NextRelease(3)
2
3
4
6 Dist::Zilla::Plugin::NextRelease - update the next release number in
7 your changelog
8
10 version 6.031
11
13 In your dist.ini:
14
15 [NextRelease]
16
17 In your Changes file:
18
19 {{$NEXT}}
20
22 Tired of having to update your Changes file by hand with the new
23 version and release date / time each time you release your
24 distribution? Well, this plugin is for you.
25
26 Add this plugin to your dist.ini, and the following to your Changes
27 file:
28
29 {{$NEXT}}
30
31 The "NextRelease" plugin will then do 2 things:
32
33 • At build time, this special marker will be replaced with the
34 version and the build date, to form a standard changelog header.
35 This will be done to the in-memory file - the original Changes file
36 won't be updated.
37
38 • After release (when running "dzil release"), since the version and
39 build date are now part of your dist's history, the real Changes
40 file (not the in-memory one) will be updated with this piece of
41 information.
42
43 The module accepts the following options in its dist.ini section:
44
45 filename
46 the name of your changelog file; defaults to Changes
47
48 update_filename
49 the file to which to write an updated changelog to; defaults to the
50 "filename"
51
52 format
53 sprintf-like string used to compute the next value of "{{$NEXT}}";
54 defaults to "%-9v %{yyyy-MM-dd HH:mm:ssZZZZZ VVVV}d%{ (TRIAL
55 RELEASE)}T"
56
57 time_zone
58 the timezone to use when generating the date; defaults to local
59
60 user_stash
61 the name of the stash where the user's name and email address can
62 be found; defaults to %User
63
64 The module allows the following sprintf-like format codes in the
65 "format":
66
67 %v The distribution version
68
69 "%{-TRIAL}T"
70 Expands to -TRIAL (or any other supplied string) if this is a trial
71 release, or the empty string if not. A bare %T means "%{-TRIAL}T".
72
73 "%{-TRIAL}V"
74 Equivalent to "%v%{-TRIAL}T", to allow for the application of
75 modifiers such as space padding to the entire version string
76 produced.
77
78 "%{CLDR format}d"
79 The date of the release. You can use any CLDR format supported by
80 DateTime. You must specify the format; there is no default.
81
82 %U The name of the user making this release (from "user_stash").
83
84 %E The email address of the user making this release (from
85 "user_stash").
86
87 %P The CPAN (PAUSE) id of the user making this release (from -Releaser
88 plugins; see [UploadToCPAN]).
89
90 %n A newline
91
92 %t A tab
93
95 This module should work on any version of perl still receiving updates
96 from the Perl 5 Porters. This means it should work on any version of
97 perl released in the last two to three years. (That is, if the most
98 recently released version is v5.40, then this module should work on
99 both v5.40 and v5.38.)
100
101 Although it may work on older versions of perl, no guarantee is made
102 that the minimum required version will not be increased. The version
103 may be increased for any reason, and there is no promise that patches
104 will be accepted to lower the minimum required perl.
105
107 Core Dist::Zilla plugins: AutoVersion, PkgVersion, PodVersion.
108
109 Dist::Zilla roles: AfterRelease, FileMunger, TextTemplate.
110
112 Ricardo SIGNES 😏 <cpan@semiotic.systems>
113
115 This software is copyright (c) 2023 by Ricardo SIGNES.
116
117 This is free software; you can redistribute it and/or modify it under
118 the same terms as the Perl 5 programming language system itself.
119
120
121
122perl v5.38.0 2023-11-21Dist::Zilla::Plugin::NextRelease(3)