Marcel Grünauer > Module-Changes-0.05 > Module::Changes::Release

Download:
Module-Changes-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Module::Changes::Release - a release within a Changes file

SYNOPSIS ^

    use Module::Changes;
    my $release = Module::Changes->make_object_for_type('release')
    $release->touch_date;

DESCRIPTION ^

This class represents a release within the Changes file.

METHODS ^

This class inherits all methods from Module::Changes::Base.

version
    $release->version(Perl::Version->new->('0.01'));
    print $release->version;

Set or get the release's version number. You need to use a Perl::Version object.

version_as_string
    print $release->version_as_string;

Takes the release's version object and returns a string representation.

date
    $release->date(DateTime::Format::W3CDTF->new->parse_datetime(...));
    print DateTime::Format::Mail->new->format_datetime($release->date);

Set or get the release's date. You need to use a DateTime object.

author
    $release->author('Marcel Gruenauer <marcel@cpan.org>');
    print $release->author;

Set or get the release's author. It is recommended that you use a string as shown above.

changes
    $release->changes_push('Added foobar()');
    for my $change ($release->changes) { ... }

This is an array accessor giving access to all the changes contained in the release. See Class::Accessor::Complex's mk_array_accessors() for which methods are available.

Changes are just strings.

tags
    $release->tags_push('APIBREAK');
    for my $tag ($release->tags) { ... }

This is an array accessor giving access to all the tags contained in the release. See Class::Accessor::Complex's mk_array_accessors() for which methods are available.

Tags are a way to help other programs understand (or at least guess) what has happened in each release.

Tags are just strings. See the documentation for the changes program for a discussion of recommended tags.

touch_date
    $release->touch_date;

Touch the release's date, setting it to the current date andtime.

clone_version
    my $version = $release->clone_version;

Makes a clone of the release's version object. This is useful if you want to use the version in a new release. You need a clone so you don't inadvertently change this release's version number as well.

remove_tag
    $release->remove_tag('APIBREAK');

Takes a tag name and removes all occurrences of it from the tags array.

TAGS ^

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the modulechanges tag.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-module-changes@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY ^

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR ^

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2007 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: