-
Notifications
You must be signed in to change notification settings - Fork 317
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
Add support of generating machine-readable changelogs (YAML?) #253
Comments
Another option would be to embed the data as a HTML comment in the release notes? Not sure if this is even possible, but just an idea. |
It would be possible, but in such case we would need to somehow have 2 sets of |
Would it make sense to attach this as a file to a release? We might also want to think about how we can not make this part of the core of Release Drafter since this is a very specific request, I don't think many other users will have a need for this. |
Yeah, I agree that it might be a niche case. Technically we could create a Jenkins-focused GitHub App which would extend release drafter and then see whether we could upstream some bits or generalize them to be a more generic app. |
https://github.com/jenkinsci/jenkins/releases/tag/jenkins-2.190 for what I achieved so far with the standard Release Drafter. Not bad actually. What is missing there:
|
@oleg-nenashev there's also the changelog format proposed by https://keepachangelog.com/en/1.0.0/. It's still geared towards human consumption, but with a structured format, it could conceivably be machine parsed. |
As a maintainer, I would be interested to generate a machine-readable changelog in addition to user release notes.
Currently Release Drafter targets Markdown as a destination format. In the case of the Jenkins project, we maintain a machine readable changelog in YAML so that we can later generate https://jenkins.io/changelog/ and other data sources. Raw data: https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml
Currently the changelog is generated using automation scripts, but it would be great to use Release Drafter.
What would I expect from YAML generation:
Workaround
I was able to hack a workaround using non-trivial replacers to extract issue numbers and to put them into YAML.
Configuration:
Generated output:
The text was updated successfully, but these errors were encountered: