[TIMOB-12594] Ti API: Change all node.js projects to include the changelog in the package.json file
| GitHub Issue | n/a |
|---|---|
| Type | Story |
| Priority | High |
| Status | Closed |
| Resolution | Invalid |
| Resolution Date | 2013-05-20T22:55:48.000+0000 |
| Affected Version/s | Release 3.0.0 |
| Fix Version/s | 2013 Sprint 10 |
| Components | TiAPI |
| Labels | n/a |
| Reporter | Bryan Hughes |
| Assignee | Ingo Muschenetz |
| Created | 2013-02-05T18:46:12.000+0000 |
| Updated | 2017-03-20T20:49:07.000+0000 |
Description
Right now, getting the changelog for one of our node.js projects (cli, alloy, code processor, etc) is difficult because you have to first download that version of the project. If we put the changelog in the package.json file, this can be fetched via 'npm info ' without downloading the entire project.
This should probably be put in a "changelog" field and, for readabilities sake, should probably go at the end.
The format will be Markdown
Appears there is a Java library we can use to read markdown: http://code.google.com/p/markdownj/
Subtasks: node-appc, titanium, code processor, alloy, create script to automate (hook into npm?), approval sub-task
We still don't have this in place, so we're missing release notes for all of these packages. Ingo came up with the following alternate suggestion: if we tag each of these releases in github, we can pull the CHANGELOG.md directly from github using the tag, like this: https://github.com/appcelerator/titanium_mobile/blob/3_1_0_GA/README.md Any objections? We should really get this fixed, and this would at least get proper release notes showing up in Studio. Plus, we should probably be tagging releases anyway.
We have implemented another solution wherein we tag each release in Git, allowing studio to query that tag and getting the changelog at that version.
Closing ticket as invalid.