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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
NAME
Dist::Zilla::Plugin::OurPkgVersion - No line insertion and does Package
version with our
VERSION
version 0.21
SYNOPSIS
in dist.ini
[OurPkgVersion]
in your modules
# VERSION
DESCRIPTION
This module was created as an alternative to
Dist::Zilla::Plugin::PkgVersion and uses some code from that module.
This module is designed to use a the more readable format our $VERSION
= $version; as well as not change then number of lines of code in your
files, which will keep your repository more in sync with your CPAN
release. It also allows you slightly more freedom in how you specify
your version.
EXAMPLES
in dist.ini
...
version = 0.01;
[OurPkgVersion]
in lib/My/Module.pm
package My::Module;
# VERSION
...
output lib/My/Module.pm
package My::Module;
our $VERSION = '0.01'; # VERSION
...
please note that whitespace before the comment is significant so
package My::Module;
BEGIN {
# VERSION
}
...
becomes
package My::Module;
BEGIN {
our $VERSION = '0.01'; # VERSION
}
...
while
package My::Module;
BEGIN {
# VERSION
}
...
becomes
package My::Module;
BEGIN {
our $VERSION = '0.01'; # VERSION
}
...
you can also add additional comments to your comment
...
# VERSION: generated by DZP::OurPkgVersion
...
becomes
...
our $VERSION = '0.1.0'; # VERSION: generated by DZP::OurPkgVersion
...
you can also use perltidy's default static side comments (##)
...
## VERSION
...
becomes
...
our $VERSION = '0.1.0'; ## VERSION
...
Also note, the package line is not in any way significant, it will
insert the our $VERSION line anywhere in the file before # VERSION as
many times as you've written # VERSION regardless of whether or not
inserting it there is a good idea. OurPkgVersion will not insert a
version unless you have # VERSION so it is a bit more work.
If you make a trial release, the comment will be altered to say so:
# VERSION
becomes
our $VERSION = '0.01'; # TRIAL VERSION
METHODS
BUILD
Provides validations after object creation.
munge_files
Override the default provided by Dist::Zilla::Role::FileMunger to
limit the number of files to search to only be modules and
executables.
munge_file
tells which files to munge, see Dist::Zilla::Role::FileMunger.
finder
Override the default FileFinder for finding files to check and
update. The default value is :InstallModules and :PerlExecFiles (when
available; otherwise :ExecFiles) -- see also
Dist::Zilla::Plugin::ExecDir, to make sure the script files are
properly marked as executables for the installer.
PROPERTIES
underscore_eval_version
For version numbers that have an underscore in them, add this line
immediately after the our version assignment:
$VERSION = eval $VERSION;
This is arguably the correct thing to do, but changes the line
numbering of the generated Perl module or source, and thus optional.
semantic_version
Setting this property to "true" (1) will set the version of the
module/distribution to properly use semantic versioning. It will also
expect that you setup version with a v-string, without adding quotes.
For example:
version = v0.0.1
Beware you can't setup both underscore_eval_version and
semantic_version since both are mutually exclusive: if you try, your
code is going to die.
For more details, check this blog
<https://weblog.bulknews.net/how-to-correctly-use-semantic-version-vx-y-z-in-perl-modules-eb08568ab911>
for more details about using semantic version with Perl.
skip_main_module
Set to true to ignore the main module in the distribution. This
prevents a warning when using
Dist::Zilla::Plugin::VersionFromMainModule to obtain the version
number instead of the dist.ini file.
overwrite
When enabled, this option causes any match of the # VERSION comment
to first check for an existing our $VERSION = ...; on the same line,
and if found, overwrite the value in the existing statement. (the
comment still gets modified for trial releases)
Currently, the value must be a single Perl token such as a string or
number.
no_critic
When underscore_eval_version is used the generated code for dev
versions may not technically be Perl::Critic compliant due to string
eval, but is nevertheless pretty safe. This option will add the
appropriate no critic directive to save you the hassle.
BUGS
Please report any bugs or feature requests on the bugtracker website
https://github.com/plicease/dist-zilla-plugin-ourpkgversion/issues
When submitting a bug or request, please include a test-file or a patch
to an existing test-file that illustrates the bug or desired feature.
CONTRIBUTORS
* Alceu Rodrigues de Freitas Junior <alceu.junior@quintoandar.com.br>
* Ian Sealy <git@iansealy.com>
* Michael Conrad <mike@nrdvana.net>
* Michael Jemmeson <mjemmeson@cpan.org>
* Stephan Loyd <stephanloyd9@gmail.com>
* Alceu Rodrigues de Freitas Junior <arfreitas@cpan.org>
* Alexandr Ciornii <alexchorny@gmail.com>
* Alexei Znamensky <russoz@cpan.org>
* Christian Walde <walde.christian@googlemail.com>
* Christopher J. Madsen <perl@cjmweb.net>
* David Golden <dagolden@cpan.org>
* Graham Ollis <perl@wdlabs.com>
* Graham Ollis <plicease@cpan.org>
* Graham✈️✈️ <plicease@cpan.org>
AUTHORS
* Caleb Cushing <xenoterracide@gmail.com>
* Grahan Ollis <plicease@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2019 by Caleb Cushing.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
|
