pk-changelog.json

{
  "name": "Progress-Keeper",
  "desc": "Track, transform and present changelog entries.",
  "releases": [
    {
      "version": "0.4.1",
      "date": "2018-05-08",
      "remarks": "To be announced.",
      "changelog": [
        {
          "date": "2018-05-08",
          "type": "upd",
          "scope": "doc",
          "desc": "Added log entry example using field 'scope' (JSON sample snippet in README).",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.4.0",
      "date": "2018-05-08",
      "remarks": "This release has an improved README with some detailed API usage examples.",
      "changelog": [
        {
          "date": "2018-05-08",
          "type": "upd",
          "scope": "doc",
          "desc": "Added CLI and API usage examples and re-ordered some paragraphs in README.",
          "audience": "*"
        },
        {
          "date": "2018-05-08",
          "type": "upd",
          "desc": "progress-keeper CLI now dumps usage information if parameters are missing.",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.3.4",
      "date": "2018-05-08",
      "remarks": "Another service release with few updates on internal dependencies.",
      "changelog": [
        {
          "date": "2018-05-08",
          "type": "upd",
          "scope": "ci",
          "desc": "Changed install workflow to 'composer update' (instead of install).",
          "audience": "*"
        },
        {
          "date": "2018-05-08",
          "type": "chore",
          "desc": "Adjusted composer dependencies for alternative php versions (5 or 7) again.",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.3.3",
      "date": "2018-05-03",
      "remarks": "Small service release with few updates on internal dependencies.",
      "changelog": [
        {
          "date": "2018-05-03",
          "type": "chore",
          "desc": "Updated to latest composer version (included as phar file).",
          "audience": "*"
        },
        {
          "date": "2018-05-03",
          "type": "chore",
          "desc": "Updated dependency on league/commonmark (0.17.0 -> 0.17.5).",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.3.2",
      "date": "2018-03-26",
      "remarks": "Small bugfix release providing a fix for the HTML presenter.",
      "changelog": [
        {
          "date": "2018-03-26",
          "type": "fix",
          "desc": "HTML presenter won't convert special characters into their corresponding html entities.",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.3.1",
      "date": "2018-02-26",
      "remarks": "Small service release providing some improvements in detail.",
      "changelog": [
        {
          "date": "2018-02-27",
          "type": "doc",
          "desc": "Improved introduction, corrected some details about current API, added hints for contributors.",
          "audience": "*"
        },
        {
          "date": "2018-02-26",
          "type": "chore(ci)",
          "desc": "Added additional Travis CI test runner for PHP 7.2.",
          "audience": "*"
        },
        {
          "date": "2018-02-26",
          "type": "upd",
          "desc": "BREAKING CHANGE: HTML presenter now renders the log entry scope value (if present) as prefix of the description.",
          "audience": "*"
        },
        {
          "date": "2018-02-26",
          "type": "upd",
          "desc": "HTML presenter now adds a css class 'pk-logentry-type-[type]' class to log entry inline element.",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.3.0",
      "date": "2018-02-26",
      "remarks": "Simple markdown presenter, new progress-keeper command, Travis CI integration and more.",
      "changelog": [
        {
          "date": "2018-02-21",
          "type": "chore",
          "desc": "Locked composer deps to PHP 5.6 compatible versions.",
          "audience": "dev"
        },
        {
          "date": "2018-02-26",
          "type": "feat",
          "desc": "Added new reader type: Markdown. Parses a markdown changelog from AST which is structured like the one the markdown presenter generates.",
          "audience": "*"
        },
        {
          "date": "2018-02-25",
          "type": "upd",
          "desc": "BREAKING CHANGE: Markdown presenter now renders types in the form 'type:' instead of '[type]'.",
          "audience": "*"
        },
        {
          "date": "2018-02-25",
          "type": "refac",
          "desc": "BREAKING CHANGE: Renamed methods for parsing changelog, releases and log entries from from array to readFromArray().",
          "audience": "dev"
        },
        {
          "date": "2018-02-25",
          "type": "refac",
          "desc": "BREAKING CHANGE: Changed signature of LogEntryType constructor now parsing first argument as 'conventional commit message'.",
          "audience": "dev"
        },
        {
          "date": "2018-02-25",
          "type": "feat",
          "desc": "Extended LogEntryType by introducing field 'scope' and adding methods parsing type, scope and description from conventional commit messages and types.",
          "audience": "dev"
        },
        {
          "date": "2018-02-21",
          "type": "refac",
          "desc": "Extracted AbstractReader providing basic member and access methods.",
          "audience": "dev"
        },
        {
          "date": "2018-02-19",
          "type": "doc",
          "desc": "Added Travis CI badge.",
          "audience": "dev"
        },
        {
          "date": "2018-02-19",
          "type": "chore(ci)",
          "desc": "Added integration with Travis CI.",
          "audience": "dev"
        },
        {
          "date": "2018-02-18",
          "type": "refac",
          "desc": "Extracted method getCanonicalType() and moved it to class LogEntryType.",
          "audience": "dev"
        },
        {
          "date": "2018-02-17",
          "type": "doc",
          "desc": "Added syntax highlighting for JSON changelog example.",
          "audience": "*"
        },
        {
          "date": "2018-02-17",
          "type": "doc",
          "desc": "Updated README by adding a paragraph about the internal JSON format plus some basic model and API concepts.",
          "audience": "*"
        },
        {
          "date": "2018-02-17",
          "type": "chore",
          "desc": "Added composer 'pre-commit' script which builds markdown and HTML versions of the own PK changelog.",
          "audience": "dev"
        },
        {
          "date": "2018-02-16",
          "type": "feat",
          "desc": "Added simple command which calls factory method 'getConvertedChangelog' with CLI arguments.",
          "audience": "*"
        },
        {
          "date": "2018-02-16",
          "type": "chore",
          "desc": "Renamed 'release-info.json' files to 'pk-changelog.json'.",
          "audience": "*"
        },
        {
          "date": "2018-02-16",
          "type": "feat",
          "desc": "Added new presenter: Markdown. Allows for generating simple markdown from given changelog.",
          "audience": "*"
        },
        {
          "date": "2018-02-16",
          "type": "test",
          "desc": "Added test class for testing presenters + extracted sample changelog generation to JsonSampleTextCase super class.",
          "audience": "dev"
        },
        {
          "date": "2018-02-16",
          "type": "update",
          "desc": "BREAKING CHANGE: Changed output for HTML presenter: New tag structure and prettified formatting.",
          "audience": "*"
        }
      ]
    },
    {
      "version": "0.2.0",
      "date": "2018-02-14",
      "remarks": "New log entry type list + filter and sort methods + a lot of housekeeping.",
      "changelog": [
        {
          "date": "2018-02-14",
          "type": "feat",
          "desc": "Added method to fetch latest release (i.e. top most) of a changelog.",
          "audience": "*"
        },
        {
          "date": "2018-02-13",
          "type": "feat",
          "desc": "Added method to fetch version string of latest release (i.e. top most) of a changelog.",
          "audience": "*"
        },
        {
          "date": "2018-02-13",
          "type": "update",
          "desc": "BREAKING CHANGE: Minor corrections of class names for releases -> release -> logentries -> logentry.",
          "audience": "*"
        },
        {
          "date": "2018-02-09",
          "type": "feat",
          "desc": "Added methods to order (group) log entries by type, using default or a custom type order.",
          "audience": "*"
        },
        {
          "date": "2018-02-09",
          "type": "upd",
          "desc": "Added (most) log entry types found in \"keep-a-changelog\" and various log entry (commit) type aliases.",
          "audience": "*"
        },
        {
          "date": "2018-02-09",
          "type": "chore",
          "desc": "Consistently renamed changeLog (camelCase) to changelog (lowercase).",
          "audience": "dev"
        },
        {
          "date": "2018-02-09",
          "type": "feat",
          "desc": "Added methods to filter log entries to specific audience(s).",
          "audience": "dev"
        },
        {
          "date": "2018-02-09",
          "type": "test",
          "desc": "Renaming test classes after unintentionally adding fragment 'sample' to all test cases.",
          "audience": "dev"
        },
        {
          "date": "2018-02-09",
          "type": "refac",
          "desc": "BREAKING CHANGE: Removed class ProgressKeeper and refactored methods of ProgressKeeperInterface.",
          "audience": "dev"
        },
        {
          "date": "2018-02-08",
          "type": "update",
          "desc": "BREAKING CHANGE: Field identifier (key) 'adnc' is replaced by 'audi' as an alias for 'audience'.",
          "audience": "dev"
        }
      ]
    },
    {
      "version": "0.1.0",
      "date": "2018-02-08",
      "remarks": "Initial release: Provides a basic factory class methods allowing a json -> html transformation.",
      "changelog": [
        {
          "date": "2018-02-08",
          "type": "chore",
          "desc": "Release 0.1.0",
          "audience": "dev"
        },
        {
          "date": "2018-02-07",
          "type": "feat",
          "desc": "Added methods for adding releases to changelogs. Object model hierarchy is now: changelog -> releases -> log entries",
          "audience": "*"
        },
        {
          "date": "2018-02-07",
          "type": "feat",
          "desc": "Added methods for adding log entries to releases.",
          "audience": "*"
        },
        {
          "date": "2018-02-07",
          "type": "fix",
          "desc": "Only mandatory log entry fields would be correctly set by parse-from-array method.",
          "audience": "*"
        },
        {
          "date": "2018-02-06",
          "type": "doc",
          "desc": "Clarified main goals of this project + some cosmetic changes.",
          "audience": "*"
        },
        {
          "date": "2018-02-06",
          "type": "feat",
          "desc": "Added classes representing log entries and releases.",
          "audience": "*"
        },
        {
          "date": "2018-02-06",
          "type": "doc",
          "desc": "Committing this project to the follow the principles of conventional-changelog and keep-a-changelog.",
          "audience": "*"
        },
        {
          "date": "2018-01-31",
          "type": "feature",
          "desc": "Very first sketch using a Reader/Presenter interface concept and a ProgressKeeperFactory.",
          "audience": "*"
        }
      ]
    }
  ]
}