The releasenotes from micbakos

releasenotes's People

Contributors

Stargazers

Watchers

releasenotes's Issues

Use YAML for configuration files

Hello and thank you for this tool! 💯

With this issue I'd like to propose an enhancement regarding configuring the script.
The enhancement would be to use YAML for providing
the configuration, as it is more easily configurable by humans and less verbose than json.

Below I've attached a sample of how the configuration would look like, compared with json.
For doing that there are a couple of options when it comes to Kotlin:

Hoplite
Kaml

I'd be happy to provide an upstream change if you would find this change useful 😄

Example

JSON

{
  "variants": [
    {
      "name": "passenger",
      "categories": [
        {
          "title": "Product",
          "regex": "taxibeat\\/(passenger|all)\\/(feature)\\/(?!infra).+\\/.+"
        },
        {
          "title": "Infra",
          "regex": "taxibeat\\/(passenger|all)\\/(feature|chapter)\\/infra\\/.+"
        },
        {
          "title": "Bugs",
          "regex": "taxibeat\\/(passenger|all)\\/(bugfix|hotfix)\\/.+"
        }
      ]
    },
    {
      "name": "driver",
      "categories": [
        {
          "title": "Product",
          "regex": "taxibeat\\/(driver|all)\\/(feature)\\/(?!infra).+\\/.+"
        },
        {
          "title": "Infra",
          "regex": "taxibeat\\/(driver|all)\\/(feature|chapter)\\/infra\\/.+"
        },
        {
          "title": "Bugs",
          "regex": "taxibeat\\/(driver|all)\\/(bugfix|hotfix)\\/.+"
        }
      ]
    }
  ],
  "links": [
    {
      "url": "https://jira.taxibeat.com/browse/$1",
      "regex": "\\[(\\D+-\\d+)\\]"
    }
  ]
}

YAML


variants:
 - name: passenger
   categories:
    - title: Product
      regex: taxibeat\/(passenger|all)\/(feature)\/(?!infra).+\/.+
    - title: Infra
      regex: taxibeat\/(passenger|all)\/(feature|chapter)\/infra\/.+
    - title: Bugs
      regex: taxibeat\/(passenger|all)\/(bugfix|hotfix)\/.+
 - name: driver
   categories:
    - title: Product
      regex: taxibeat\/(driver|all)\/(feature)\/(?!infra).+\/.+
    - title: Infra
      regex: taxibeat\/(driver|all)\/(feature|chapter)\/infra\/.+
    - title: Bugs
      regex: taxibeat\/(driver|all)\/(bugfix|hotfix)\/.+
links:
 - url: "https://jira.taxibeat.com/browse/$1"
   regex: '\[(\D+-\d+)\]'

Recommend Projects