David Golden > Dist-Zilla-Plugin-CheckChangesHasContent-0.007 > Dist::Zilla::Plugin::Test::ChangesHasContent

Download:
Dist-Zilla-Plugin-CheckChangesHasContent-0.007.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.007   Source  

NAME ^

Dist::Zilla::Plugin::Test::ChangesHasContent - Release test to ensure Changes has content

VERSION ^

version 0.007

SYNOPSIS ^

  # in dist.ini

  [Test::ChangesHasContent]

DESCRIPTION ^

This plugin provides xt/release/changes_has_content.t.

This test ensures ensures that your Changes file actually has some content since the last release.

This can be contrasted to Dist::Zilla::Plugin::CheckChangesHasContent, which performs the check at release time, halting the release process if content is missing. Performing the check as a test makes it possible to check more frequently, and closer to the point of development.

The algorithm is very naive. It looks for an unindented line starting with the version to be released. It then looks for any text from that line until the next unindented line (or the end of the file), ignoring whitespace.

For example, in the file below, algorithm will find "- blah blah blah":

  Changes file for Foo-Bar

  {{$NEXT}}

    - blah blah blah

  0.001  Wed May 12 13:49:13 EDT 2010

    - the first release

If you had nothing but whitespace between {{$NEXT}} and 0.001, the release would be halted.

If you name your change log something other than "Changes", you can configure the name with the changelog argument:

  [Test::ChangesHasContent]
  changelog = ChangeLog

SEE ALSO ^

* Dist::Zilla::Plugin::CheckChangesHasContent * Dist::Zilla

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2014 by David Golden.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
syntax highlighting: