cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From swill <...@git.apache.org>
Subject [GitHub] cloudstack pull request #1658: Added an additional JSON diff output to the A...
Date Tue, 23 Aug 2016 16:23:59 GMT
GitHub user swill opened a pull request:

    https://github.com/apache/cloudstack/pull/1658

    Added an additional JSON diff output to the ApiXmlDocReader

    The original TXT diff format is very hard to work with if you are trying to programmatically
use the output to generate documentation.  Previously, @pdion891 spent a lot of time trying
to manually reformat this output in order for it to be represented in the Release Notes.
    
    This pull request adds JSON as an output format as well as the existing TXT to simplify
the ability for parsers and generators to use the output.
    
    This new JSON format was used to generate the 4.9.0 release notes (that code will be contributed
separately).
    
    Old manually formatted output: 
    http://docs.cloudstack.apache.org/projects/cloudstack-release-notes/en/4.7.0/api-changes.html
    
    New auto-formatted output using this new JSON output: 
    http://docs.cloudstack.apache.org/projects/cloudstack-release-notes/en/4.9.0/api-changes.html
    
    I have included the output of the `diff.txt` as well as the `diff.json` to this PR so
you can see the resulting output of both file formats (diff between 4.8 and 4.9).
    
    [diff.txt.zip](https://github.com/apache/cloudstack/files/432983/diff.txt.zip)
    [diff.json.zip](https://github.com/apache/cloudstack/files/432982/diff.json.zip)
    


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/swill/cloudstack api_diff_gen

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/cloudstack/pull/1658.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1658
    
----
commit 9d61ebc88295e63acacae5fedf2e3da398a1dc4f
Author: Will Stevens <williamstevens@gmail.com>
Date:   2016-06-17T20:07:58Z

    Added JSON diff output to the ApiXmlDocReader in additon TXT for parsability

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message