atufkas / progress-keeper Goto Github PK

A new Reader implementation for GIT ("GitReader") should enable developers to "reversely" generate a changelog by fetching messages from a GIT commit log history, ideally by parsing tags as releases and their commits as log entries. At first place it should be possible

• fetch a specific commit history by passing the GIT repo url
• define a specific tag to parse (parse all by default)

Enhanced features could be:

• defining a tag range to be fetched and parsed
• a list of conversion rules for
  • setting defaults missing message (log entry) types
  • defining mappings for unknown message types
  • defining filter rules for messages to be skipped (regex...)

In the ideal world, a git commit history is clean, already in conventional commit log format and only consists of meaningful change sets and useful commit messages. However, the real world shows us that we'll always have a lot of noise (for good reason): Cleanups, merges, typo corrections are just a few examples.

To be inline with the conventional commit specification we'll need support for real body and footer sections of a log entry.

The JSON might be extended like that:

    {
      "date": "2018-05-08",
      "type": "upd",
      "scope": "ci",
      "desc": "Changed Travis CI install workflow to 'composer update' (instead of install).",
      "body": ["Note: Travis CI is configured to run composer update.", "Cheers, your dev-team."]
      "footer": "fixes #1, #4.",
      "audience": "*"
    },

The value of the body attribute might either be a single string or an array, where elements of arrays mark a single paragraph within the body.

What kind of log entry types are actually needed in daily development?

• Is the currently available list of types too long, too short or just right?

• Do we need more aliases?

• Would it make sense to modify the LogEntryType class to be easily modified/extended to customer needs?

• Should we just strictly follow a popular guideline like the Angular Commit Message Guidelines?

Suggestions welcome!