Comments (3)
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.
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.
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)
- Don't strip all leading whitespace from release notes HOT 1
- usage in travis-ci HOT 17
- Github enterprise HOT 4
- customizable release title HOT 3
- allow specify version to update HOT 1
- gitlab support HOT 2
- strip markdown links HOT 7
- Warn before overwriting existing releases HOT 2
- Feature request: Rake task for automatically invoking Chandler in projects that lack a .gemspec HOT 6
- Allow configuration of chandler through a dotfile HOT 2
- (Optional) replace full GH issue links with just #NUMBER HOT 1
- More gentle error on not existing tag HOT 2
- Tag-Prefix does not work as expected HOT 2
- Gentle Version Handling HOT 4
- Consider using vandamme gem to parse changelogs
- on release notes update are version dates overwritten to current date HOT 7
- source code requires UTF-8 HOT 4
- Auto-uploading binaries HOT 2
- Workflow question HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from chandler.