File: README.mkdn

package info (click to toggle)
libsoftware-release-perl 0.02-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 128 kB
  • sloc: perl: 87; makefile: 2
file content (75 lines) | stat: -rw-r--r-- 1,612 bytes parent folder | download
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
# NAME

Software::Release - Object representing a release of software.

# VERSION

version 0.02

# SYNOPSIS

    use DateTime;
    use Software::Release;
    use Software::Release::Change;

    my $change = Software::Release::Change->new(
        author => 'gphat',
        change_id => 'abc1234',
        date => DateTime->now,
        description => 'Frozzled the wozjob'
    );

    my $rel = Software::Release->new(
        version => '0.1',
        name => 'Angry Anteater',
        date => DateTime->now,
    );

    $rel->add_to_changes($change);

# DESCRIPTION

Software::Release is a purely informational collection of objects that you
can use to represent a release of software.  It's original use-case was to
provide a contract between a git log parser and a formatter class that output
a changelog, but it may be useful to others create bug trackers, dashboards
or whathaveyour.

# ATTRIBUTES

## changes

A list of [Software::Release::Change](http://search.cpan.org/perldoc?Software::Release::Change) objects for this release.

## date

The date this software was released.

## name

The name of this release.

## version

The version of the release, as a string.

# METHODS

## add_to_changes ($change)

Add a change to this release's list of changes.

## has_no_changes

Returns true if this release's list of changes is empty.

# AUTHOR

Cory G Watson <gphat@cpan.org>

# COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Infinity Interactive, Inc.

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