s3krit / changelogerator Goto Github PK

On substrate we intend to provide changelogs with upgrade-instructions on a per-crate bases soon. These will either sit in a changelog.md or upgrades.md for each crate. The changelog generator should optionally include the sections added to these files between two releases.

Today (0.9.1) we have:

"meta": {
      "B": {
        "min": 0,
        "max": 7,
        "count": 25
      },...

It would be useful to add finer aggregate per number:

"meta": {
      "B": {
        "min": 0,
        "max": 7,
        "count": 25,
        "details": {
            0: {
                "count": 12
            } ,
            ...
        }
      },...

In the current version, we are rather opinionated about how to handle mutually exclusive labels and we say that we cannot have a B0 and a B1 on the same change. If we do, we record only the B1.

This may be a requirement that is too strong but it makes it also easier in most cases.

We could imagine a repo where some labels are mutually exclusive while some are not.

For instance, a change may very well be a Bug or a Feature but both a UI and Documentation change.

Since we require "pry", it should not be in the dev group.