| 1 |
Revision history for Pod-Readme |
| 2 |
|
| 3 |
v1.2.3 2018-10-31 22:56:42+00:00 Europe/London |
| 4 |
[Bug Fixes] |
| 5 |
- Increased minimum version of Type::Tiny to 1.000000. |
| 6 |
|
| 7 |
v1.2.2 2018-10-31 22:41:45+00:00 Europe/London |
| 8 |
[Documentation] |
| 9 |
- Updated POD with regard to format types (Mohammad S Anwar). |
| 10 |
|
| 11 |
- Fixed typos in Changes. |
| 12 |
|
| 13 |
[Bug Fixes] |
| 14 |
- Added explicit requirements for Pod::Simple as well as recommended |
| 15 |
modules. |
| 16 |
|
| 17 |
[Toolchain] |
| 18 |
- Remove explicit core dependencies from prereqs list. |
| 19 |
|
| 20 |
- Updated list of contributors in distribution metadata. (Apologies |
| 21 |
if anyone was omitted.) |
| 22 |
|
| 23 |
v1.2.1 2018-10-30 18:23:48+00:00 Europe/London |
| 24 |
[Documentation] |
| 25 |
- Added note about Github Flavoured Markdown (GFM) support |
| 26 |
to Changes for v1.2.0. |
| 27 |
|
| 28 |
[Other] |
| 29 |
- Restore license to "Perl_5" that was inadvertently changed |
| 30 |
in the conversion to use Dist::Zilla, GH#25. |
| 31 |
|
| 32 |
v1.2.0 2018-10-29 19:24:01+00:00 Europe/London |
| 33 |
[Bug Fixes] |
| 34 |
- Specify minimum version of List::Util, GH#22. |
| 35 |
|
| 36 |
[Enhancements] |
| 37 |
- Added "md" as an alias for "markdown" in pod2readme. |
| 38 |
|
| 39 |
- Added "github" or "gfm" for Github Flavored Markdown in |
| 40 |
pod2readme, GH#15. |
| 41 |
|
| 42 |
[Incompatabilities] |
| 43 |
- Removed DistZilla type from Pod::Readme::Types, as it was not |
| 44 |
necessary. |
| 45 |
|
| 46 |
[Toolchain] |
| 47 |
- Remove use of Module::Install, fixes GH#21. |
| 48 |
|
| 49 |
- Use Dist::Zilla to build the distribution. |
| 50 |
|
| 51 |
v1.1.2 2014-12-09 18:55 GMT |
| 52 |
[Bug Fixes] |
| 53 |
- Regex in changes plugin fixed to work with Perl 5.21 deprecated |
| 54 |
syntax [khwilliamson]. |
| 55 |
|
| 56 |
v1.1.1 2014-12-04 13:11 GMT |
| 57 |
[Bug Fixes] |
| 58 |
- The changes plugin will work with Dist::Zilla v1.2.3 2018-10-31 22:56:42+00:00 Europe/London tokens. |
| 59 |
|
| 60 |
v1.1.0 2014-12-03 19:08 GMT |
| 61 |
[Documentation] |
| 62 |
- Fixed typos in POD for requires plugin. |
| 63 |
|
| 64 |
[Enhancements] |
| 65 |
- Pod::Readme::Filter has a zilla attribute for Dist::Zilla objects. |
| 66 |
|
| 67 |
- The requires plugin will use metadata from the Dist::Zilla object |
| 68 |
if it is set, rather than looking for a META.yml file (which will |
| 69 |
not exist, if this is used in a Dist::Zilla plugin). |
| 70 |
|
| 71 |
v1.0.3 2014-11-07 18:58 GMT |
| 72 |
- Fixed bug with minimum version of Class::Method::Modifiers. |
| 73 |
|
| 74 |
v1.0.2 2014-10-13 22:18 BST |
| 75 |
- No changes since v1.0.1_08, just a version bump for a release. |
| 76 |
|
| 77 |
- See the full list of changes since v1.0.0 for more details. |
| 78 |
|
| 79 |
[Enhancements] |
| 80 |
- This is a complete rewrite, using modern Perl with Moo. |
| 81 |
|
| 82 |
- Added support for plugins, along with plugins to insert the module |
| 83 |
version, prerequisites and the latest changes. |
| 84 |
|
| 85 |
- Added the ability to generate a README in a variety of formats, |
| 86 |
such as POD, Markdown, HTML, RTF, etc. |
| 87 |
|
| 88 |
- Added command-line options to the pod2readme script, including the |
| 89 |
ability to specify the output format. |
| 90 |
|
| 91 |
- Switched to semantic versioning. |
| 92 |
|
| 93 |
- The documentation has been updated accordingly. |
| 94 |
|
| 95 |
[Incompatabilities] |
| 96 |
- Perl v5.10.1 is required. |
| 97 |
|
| 98 |
- This is no longer a subclass of a POD parser, although it has some |
| 99 |
wrapper methods for compatability with software known to use it. |
| 100 |
|
| 101 |
v1.0.1_08 2014-10-13 |
| 102 |
[Documentation] |
| 103 |
- More documentation tweaks. |
| 104 |
|
| 105 |
v1.0.1_07 2014-10-10 16:47 BST |
| 106 |
[Documentation] |
| 107 |
- More documentation tweaks. |
| 108 |
|
| 109 |
[Enhancements] |
| 110 |
- Added a depends_on method that returns a list of files that the |
| 111 |
README depends on. |
| 112 |
|
| 113 |
- Added dependencies_updated method to check if dependencies have |
| 114 |
been updated. |
| 115 |
|
| 116 |
- The README is only updated if dependencies have been updated. |
| 117 |
|
| 118 |
- Added a --force option to pod2readme to force updates. |
| 119 |
|
| 120 |
[Other Changes] |
| 121 |
- Moved pod2readme tests to xt directory for author tests, due to |
| 122 |
inconsistent behaviour on different platforms. |
| 123 |
|
| 124 |
v1.0.1_06 2014-10-10 |
| 125 |
[Documentation] |
| 126 |
- More documentation tweaks. |
| 127 |
|
| 128 |
- Changed pod2readme usage text to match abstract. |
| 129 |
|
| 130 |
[Bug Fixes] |
| 131 |
- Added minimum Perl version to Makefile.PL. |
| 132 |
|
| 133 |
- Removed use of Path::Class in pod2readme utility. |
| 134 |
|
| 135 |
[Other Changes] |
| 136 |
- Added rudimentary tests for pod2readme script. |
| 137 |
|
| 138 |
[Enhancements] |
| 139 |
- The requires plugin uses minimum module versions to check if a |
| 140 |
module is in the core-list. |
| 141 |
|
| 142 |
v1.0.1_05 2014-10-09 19:36 BST |
| 143 |
[Documentation] |
| 144 |
- Corrected typos in POD. |
| 145 |
|
| 146 |
[Bug Fixes] |
| 147 |
- Disabled use of Test::Kit, since it seems to have problems with |
| 148 |
Test::Builder 1.301001_056. |
| 149 |
|
| 150 |
v1.0.1_04 2014-10-08 23:27 BST |
| 151 |
[Documentation] |
| 152 |
- Changed abstract to make the module's purpose more obvious. |
| 153 |
|
| 154 |
[Bug Fixes] |
| 155 |
- Added missing IO::String prereq to tests. |
| 156 |
|
| 157 |
v1.0.1_03 2014-10-08 22:42 BST |
| 158 |
[Documentation] |
| 159 |
- Added Acknowledgements section to POD. |
| 160 |
|
| 161 |
[Bug Fixes] |
| 162 |
- Added minimum version prereq of Moo to fix issue with undef |
| 163 |
defaults. |
| 164 |
|
| 165 |
[Enhancements] |
| 166 |
- Changed to use Path::Tiny instead of Path::Class. |
| 167 |
|
| 168 |
- Reverted back to using Exporter, since most core modules already |
| 169 |
use it. |
| 170 |
|
| 171 |
v1.0.1_02 2014-10-08 00:49 BST |
| 172 |
[Documentation] |
| 173 |
- Added missing timestamp to Changes. |
| 174 |
|
| 175 |
- Updated README.pod. |
| 176 |
|
| 177 |
[Other Changes] |
| 178 |
- Changed how versions are defined in modules, to handle quirks of |
| 179 |
namespace::autoclean. |
| 180 |
|
| 181 |
- Changed to use Exporter::Lite. |
| 182 |
|
| 183 |
v1.0.1_01 2014-10-08 00:26 BST |
| 184 |
[Bug Fixes] |
| 185 |
- Fixed argument name for include command. |
| 186 |
|
| 187 |
- Changed tests to compare files so they handle different Windows |
| 188 |
line endings. |
| 189 |
|
| 190 |
[Documentation] |
| 191 |
- Fixed POD errors and typos. |
| 192 |
|
| 193 |
[Enhancements] |
| 194 |
- Switched to use Type::Tiny-based types, with stricter constraints. |
| 195 |
|
| 196 |
- Switched to use Moo instead of Moose. |
| 197 |
|
| 198 |
[Other Changes] |
| 199 |
- Minor internal code tweaks. |
| 200 |
|
| 201 |
v1.0.0_03 2014-09-24 21:14 BST |
| 202 |
[Bug Fixes] |
| 203 |
- The tests for the requires plugin handle non-author builds. |
| 204 |
|
| 205 |
- Fix for tests on some systems. |
| 206 |
|
| 207 |
[Enhancements] |
| 208 |
- Show path of missing META.yml file in requires plugin. |
| 209 |
|
| 210 |
[Documentation] |
| 211 |
- Consistent names in POD. |
| 212 |
|
| 213 |
- Fixed typos in Changes file. |
| 214 |
|
| 215 |
[Other Changes] |
| 216 |
- Added hooks for author tests in Makefile.PL. |
| 217 |
|
| 218 |
- Fixed license metadata error to make CPANTS happy, and to be |
| 219 |
consistent with license in the POD. |
| 220 |
|
| 221 |
- Tests use Exporter instead of Exporter::Lite. |
| 222 |
|
| 223 |
- Tests use Test::Kit rather than Test::Most, and explicitly import |
| 224 |
the tests modules that they use. |
| 225 |
|
| 226 |
- Removed redundant prereqs from Makefile.PL. |
| 227 |
|
| 228 |
v1.0.0_02 2014-09-24 14:14 BST |
| 229 |
[Bug Fixes] |
| 230 |
- Fixed minimum version of some prerequisites for tests. |
| 231 |
|
| 232 |
[Enhancements] |
| 233 |
- Added parse_from_file and parse_from_filehandle methods for |
| 234 |
backwards compatability. |
| 235 |
|
| 236 |
[Other Changes] |
| 237 |
- Added more tests. |
| 238 |
|
| 239 |
- The bugtracker URL now refers to the GitHub issues list at |
| 240 |
https://github.com/bigpresh/Pod-Readme/issues |
| 241 |
instead of RT. |
| 242 |
|
| 243 |
- Added a version to all modules in the distribution, and a version |
| 244 |
QA test to the repo. |
| 245 |
|
| 246 |
[Documentation] |
| 247 |
- Added missing date to Changes. |
| 248 |
|
| 249 |
- Fixed typos in POD and README. |
| 250 |
|
| 251 |
- Added stub POD to Pod::Readme::Filter. |
| 252 |
|
| 253 |
- Fixed a daft typo in the Changes file. |
| 254 |
|
| 255 |
- Documented known issue in the requires plugin. |
| 256 |
|
| 257 |
- The README is now a POD document. |
| 258 |
|
| 259 |
v1.0.0_01 2014-09-23 13:58 BST |
| 260 |
[Incompatabilities] |
| 261 |
- Major rewrite, using modern Perl v5.10.1. |
| 262 |
|
| 263 |
- This module is no longer a subclass of a POD parsing |
| 264 |
module. Instead, it is a simple POD filter. |
| 265 |
|
| 266 |
[New Features] |
| 267 |
- Added support for plugins. |
| 268 |
|
| 269 |
- Added a "changes" plugin for parsing Changes files. |
| 270 |
|
| 271 |
- Added a "version" plugin for including the current version. |
| 272 |
|
| 273 |
- Added a "requires" plugin for listing module requirements. |
| 274 |
|
| 275 |
- The pod2readme script has been rewritten to take a variety of |
| 276 |
options, and can generate various formats, such as HTML, Markdown, |
| 277 |
POD or RTF. |
| 278 |
|
| 279 |
[Documentation] |
| 280 |
- Changes rewritten to conform to CPAN::Changes::Spec. |
| 281 |
|
| 282 |
- README is now in Markdown format. |
| 283 |
|
| 284 |
[Other Changes] |
| 285 |
- Switched to semantic versioning. |
| 286 |
|
| 287 |
- Added MANIFEST.SKIP to distribution. |
| 288 |
|
| 289 |
- QA tests are no longer part of the distribution. |
| 290 |
|
| 291 |
- Makefile.PL uses Module::Install. |
| 292 |
|
| 293 |
0.11 2010-12-09 |
| 294 |
|
| 295 |
- Recognise the =encoding directive, rather than dying when it's |
| 296 |
encountered. |
| 297 |
TODO: actually take heed of it. |
| 298 |
Thanks to Ivan Bessarabov for bringing this to my attention! |
| 299 |
|
| 300 |
0.10 2010-05-19 |
| 301 |
|
| 302 |
- David Precious <[email protected]> taking over maintainership |
| 303 |
|
| 304 |
- Apply POD fix patch from RT #38328, thanks to David A. Desrosiers |
| 305 |
|
| 306 |
0.09 2006-11-25 |
| 307 |
|
| 308 |
- uses Regexp::Common for URI parsing for L<> tag |
| 309 |
|
| 310 |
- added separate check for https, ftps, and svn URIs (rt.cpan.org |
| 311 |
bugs 23585 and 23613) |
| 312 |
|
| 313 |
0.081 2006-05-07 |
| 314 |
|
| 315 |
- released package without signature, due to Module::Signature |
| 316 |
issues |
| 317 |
|
| 318 |
0.08 2006-05-01 |
| 319 |
|
| 320 |
- head3/4 headings now recognized |
| 321 |
|
| 322 |
- went back to using Pod::PlainText |
| 323 |
|
| 324 |
0.07 2006-02-11 |
| 325 |
|
| 326 |
- added min version to use Pod::Text statement in source |
| 327 |
|
| 328 |
- removed multiple plans from the podcover test |
| 329 |
|
| 330 |
0.06 2006-02-09 |
| 331 |
|
| 332 |
- eliminated a warning about uninitialized values |
| 333 |
|
| 334 |
- recognizes =head3 and =head4 headings (from Pod::Text) |
| 335 |
|
| 336 |
- uses Pod::Text instead of Pod::PlainText |
| 337 |
|
| 338 |
- added internal documentation |
| 339 |
|
| 340 |
- added various QA tests |
| 341 |
|
| 342 |
- added "test" and "tests" as a rejected format |
| 343 |
|
| 344 |
0.05 2005-06-07 |
| 345 |
|
| 346 |
- pod2readme will backup an existing README file |
| 347 |
|
| 348 |
- minor updates to the documentation |
| 349 |
|
| 350 |
0.04 2005-05-18 |
| 351 |
|
| 352 |
- known other formats such as "html" are rejected |
| 353 |
|
| 354 |
- added missing prereq IO::File in Build.PL |
| 355 |
|
| 356 |
- added debug option |
| 357 |
|
| 358 |
- typos and tweaks for documentation |
| 359 |
|
| 360 |
0.03 2005-05-08 |
| 361 |
|
| 362 |
- added documentation to pod2readme script |
| 363 |
|
| 364 |
- include file start/stop marks are now Regexps |
| 365 |
|
| 366 |
- added more tests |
| 367 |
|
| 368 |
- multiple readme types can be specified in a command |
| 369 |
|
| 370 |
0.02 2005-05-06 |
| 371 |
|
| 372 |
- added tests (much needed!) |
| 373 |
|
| 374 |
- fixed issue with links being changed to refer to manpages |
| 375 |
|
| 376 |
0.01 2005-04-20 |
| 377 |
|
| 378 |
- original version |