βŒˆβŒ‹ βŽ‡ branch:  freshcode


Artifact [cbbd2a0621]

Artifact cbbd2a06212acfa104476164cf259c0da61a8097:

Wiki page [UnifiedChangeLog] by mario 2014-08-04 15:55:33.
D 2014-08-04T15:55:33.602
L UnifiedChangeLog
N text/x-markdown
P b3dace3e7d0a6c66d8068987642a7a846e5e057b
U mario
W 4902
This page contains some **research** references on which CHANGES.txt / NEWS.txt format is most universally supported. See [AutoupdateChangelog](http://fossil.include-once.org/freshcode/wiki/AutoupdateChangelog) for what's currently supported by freshcode.club.

### current

 * [CPAN::Changes::Spec](https://metacpan.org/pod/release/BRICAS/CPAN-Changes-0.23/lib/CPAN/Changes/Spec.pod) is an established format, only comprised of version numbers and enumerated changes.
 * [keepachangelog.com - Don’t let your friends dump git logs into CHANGELOGsβ„’](http://keepachangelog.com/) advocates for a Markdown-style release notes scheme.
     * Interesting find here: [vandamme ruby gem](https://github.com/tech-angels/vandamme/) to extract from NEWS.txt / NEWS.md formats with `# 1.2.3 / 2014-07-01` headings.
 * [Fabrizio Regini: Something new about changelogs](http://fabrizioregini.info/2014/04/05/something-new-about-changelogs.html) documents some more recent Markdown-inspired changelog formats, optional author tagging.
 * [Robot Operation Systems REP 132](http://www.ros.org/reps/rep-0132.html) entitles sections with version number and ISO timestamp in parens; adds a hyphen-line, and enumerates changes as usual.
 * [WP: Release Notes](http://en.wikipedia.org/wiki/Release_notes) favours a "Version 1.2" heading and enumerates changes with `-` for removals, `+` for additions, `*` for changes.
 * [Semantic Release Notes v0.3](http://www.semanticreleasenotes.org/) currently advises only on the Markdown structuring, does not prescribe version numbers or timestamp headings, but prepares for XML/JSON mappings.

### outdated

 * [WP: Changelog](http://en.wikipedia.org/wiki/Changelog) describes only a VCS changelog dump without version number
 * [GNU project NEWS-Files](http://www.gnu.org/prep/standards/standards.html#NEWS-File) follow the same scheme, lacks a version number.


## Samples

Excessive variation in the wild:

[http://www.pcre.org/changelog.txt](http://www.pcre.org/changelog.txt)

    Version 8.55 01-July-2014
    -------------------------
    1.  New foo and bar

[http://www.7-zip.org/history.txt](http://www.7-zip.org/history.txt)

    9.51 alpha     2014-07-01
    -------------------------
    - Now can do foo 
    - "Add to bar" dialog

[https://www.httrack.com/history.txt](https://www.httrack.com/history.txt)

    3.45-67
    + Fixed: buggy foo (author)
    + New: bar compiling (author)

[https://github.com/rust-lang/rust/blob/master/RELEASES.txt](https://github.com/rust-lang/rust/blob/master/RELEASES.txt)

    Version 1.2.3 (July 2014)
    -------------------------
    * Foo and bar

[https://raw.githubusercontent.com/jjangsangy/py-translate/master/HISTORY.rst](https://raw.githubusercontent.com/jjangsangy/py-translate/master/HISTORY.rst) in RST-format (PEP287 for all of PyPI ?)

    0.2.3 (2x14-7-11)
    ++++++++++++++++
    - General Foo
    - Bar Improvements

[http://www.zlib.net/ChangeLog.txt](http://www.zlib.net/ChangeLog.txt)

    Changes in 1.2.3 (01 July 2014)
    - Update cfoo [Dev]
    - Do not bar

[http://sqliteadmin.orbmu2k.de/changelog.txt](http://sqliteadmin.orbmu2k.de/changelog.txt)

    Version 0.4.3.2 Public Beta
    ===========================
    # Bugfix: foo
    + Added "bar" (thx developer)

[http://upx.sourceforge.net/upx-news.txt](http://upx.sourceforge.net/upx-news.txt)

    Changes in 1.02 (01 Jul 2014):
    * New option --foo.
    * Allow for bar signing.

[https://github.com/apache/cassandra/blob/trunk/NEWS.txt](https://github.com/apache/cassandra/blob/trunk/NEWS.txt)

    2.1
    ===
    New features
    ------------
      - Default to foo.
      - Very user-understandable text actually.

[https://twistedmatrix.com/trac/browser/trunk/twisted/topfiles/NEWS](https://twistedmatrix.com/trac/browser/trunk/twisted/topfiles/NEWS) which actually follow a predefined formatting scheme [https://twistedmatrix.com/trac/wiki/ReviewProcess#Newsfiles](https://twistedmatrix.com/trac/wiki/ReviewProcess#Newsfiles)

    Twisted Core 13.0.0 (2013-03-19)
    ================================
    Features
    --------
     - The foo was twisted.
     - And the bar was barred.

So looks like we might have to allow any random prefix text before version number and release datetime spec.


### Five is right out

While these are interesting variations, they're also completely non-standard or in any way reasonably parseable:

[http://www.freertos.org/History.txt](http://www.freertos.org/History.txt)

    Changes between V5.0.0 and V5.0.1 released 1st July 2014

               + Minor fixes to the foo.
                 The 'bar bits' funct

[http://users.jyu.fi/~vesal/kurssit/bin/ct/History.txt](http://users.jyu.fi/~vesal/kurssit/bin/ct/History.txt)

    v0.55.5a   + Updated foo.
               ! Denied bar.

Z 511363d0eb6238d22df7786480bad42a