Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support YAML changelog definitions #4

Open
codebymikey opened this issue Apr 19, 2021 · 0 comments
Open

Support YAML changelog definitions #4

codebymikey opened this issue Apr 19, 2021 · 0 comments

Comments

@codebymikey
Copy link

Given that YAML is a superset of JSON, using a YAML parser would ensure that existing JSON functionality is kept while allowing support for YAML's more advanced and human friendly features like inline comments, easier multiline entries, special characters, anchors etc.

It'd essentially allow users to define their changelog like:

{
  "extra": {
    "changelog": {
      "source": "changelog.json"
    }
  }
}

or

{
  "extra": {
    "changelog": {
      "source": "changelog.yml"
    }
  }
}

The PECL YAML extension should be preferably used if it's available, as it's more performant than third party libraries like symfony/yaml. However if the extension is unavailable, then the plugin should fallback to the third party library.

This should not result in a breaking change in the existing behaviour.

Is this a feature the plugin is willing to accommodate in the future?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant