search

mattbrictson / chandler

[unmaintained] chandler syncs your CHANGELOG entries to GitHub's release notes
MIT License
152 stars 15 forks source link

Allow other formats #20

Closed bogren closed 8 years ago

bogren commented 8 years ago

Is it out of scope for this project to allow other formats of the CHANGELOG file e.g yaml?

Edit: if not, I'd love to contribute.

mattbrictson commented 8 years ago

Right now I think that would be out of scope. Chandler was heavily inspired by http://keepachangelog.com/, and a YAML format seems to run counter to the spirit of those recommendations. I'm curious, though: is there a particular project you know of that uses a YAML CHANGELOG?

bogren commented 8 years ago

Yes, I can think of two, eigen by Artsy, our project (private repo).

Another solution I can think of is to run a script to create a temp changelog in markdown and use that with chandler to update the release notes :) (There are several parses for yaml 👉 markdown).

Edit: We convert our CHANGELOG.yml to markdown today for all user facing changelogs, e.g Hockey release notes.

mattbrictson commented 8 years ago

Interesting! In this case, since your CHANGELOG is already machine-readable, I don't think Chandler adds much value. If you want, you could write a Ruby script that uses the Chandler::GitHub class, or you could use Octokit directly, once you pull the appropriate description out the YAML. Or, like you said, you could generate Markdown from the YAML first, but that seems like overkill.

I'll close this issue because I still think this is out of scope for now.