Skip to content

Instantly share code, notes, and snippets.

@timblair
Created November 1, 2016 08:46
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save timblair/2d6e9e8740a51e4d18d11bf38ecb11c7 to your computer and use it in GitHub Desktop.
Save timblair/2d6e9e8740a51e4d18d11bf38ecb11c7 to your computer and use it in GitHub Desktop.
A quick stab at a machine-readable CHANGELOG format
{
"project": "some-project",
"url": "https://github.com/someorg/some-project",
"description": "Some project or other for SomeOrg",
"releases": [
{
"version": "1.0.0",
"date": "2014-12-05",
"items": [
{
"title": "Initial release"
}
],
"links": [
{
"type": "tree",
"url": "https://github.com/someorg/some-project/tree/v1.0.0"
}
]
},
{
"version": "1.0.1",
"date": "2014-12-15",
"items": [
{
"title": "Ensure error message displays in page flow",
"links": [
{
"type": "issue",
"title": "CC-3",
"url": "https://someorg.atlassian.net/browse/CC-3"
}
]
}
],
"links": [
{
"type": "tree",
"url": "https://github.com/someorg/some-project/tree/1.0.1"
},
{
"type": "diff",
"url": "https://github.com/someorg/some-project/compare/v1.0.0...1.0.1"
}
]
},
{
"version": "1.0.2",
"date": "2014-12-17",
"items": [
{
"title": "Support payments through new SomeOrg account",
"links": [
{
"type": "issue",
"title": "CC-6",
"url": "https://someorg.atlassian.net/browse/CC-6"
}
]
},
{
"title": "Rebuild unit tests to better cover current server behaviour",
"links": [
{
"type": "issue",
"title": "CC-8",
"url": "https://someorg.atlassian.net/browse/CC-8"
}
]
},
{
"title": "Expand the list of responses from the NullGatewayAdapter",
"links": [
{
"type": "issue",
"title": "CC-9",
"url": "https://someorg.atlassian.net/browse/CC-9"
}
]
}
],
"links": [
{
"type": "tree",
"url": "https://github.com/someorg/some-project/tree/1.0.2"
},
{
"type": "diff",
"url": "https://github.com/someorg/some-project/compare/v1.0.1...1.0.2"
}
]
},
{
"pending": true,
"items": [
{
"title": "...",
"links": [
{
"type": "issue",
"title": "CC-X",
"url": "https://someorg.atlassian.net/browse/CC-X"
}
]
}
]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment