Coder Social home page Coder Social logo

Allow other formats about chandler HOT 3 CLOSED

bogren avatar bogren commented on July 17, 2024
Allow other formats

from chandler.

Comments (3)

mattbrictson avatar mattbrictson commented on July 17, 2024 1

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.

from chandler.

mattbrictson avatar mattbrictson commented on July 17, 2024

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?

from chandler.

bogren avatar bogren commented on July 17, 2024

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.

from chandler.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.