Skip to content

Conversation

@russcam
Copy link
Contributor

@russcam russcam commented Jan 11, 2018

This commit adds a build target, diff, that can create a diff output of assemblies from

  1. files
  2. directories
  3. nuget packages
  4. github commits

by calling

.\build.bat diff <diffType=assemblies|directories|nuget|github> [project=nest|elasticsearch.net|nest.jsonserializer] <olderPathOrVersion> <newerPathOrVersion> [output=xml|markdown|asciidoc]

It uses Progress/Telerik's JustAssembly command line tool to generate an XML file of the public diffs between two assemblies, with functions implemented to transform XML to markdown and asciidoc. Since JustAssembly installation cannot be easily automated, an exception is thrown when diff is run if the tool is not installed, prompting the user with a link to download.

When specifying directories or nuget packages, the assemblies within the first path will be paired up with assemblies with the same name in the second path, and a diff will be generated for each pair.

The markdown and asciidoc conversions are very simple and can be improved over time.

Add skipdocs argument to be able to skip generating documentation.

Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@russcam russcam merged commit e0a42a5 into master Jan 14, 2018
@Mpdreamz Mpdreamz deleted the feature/diffs branch January 30, 2018 14:16
russcam added a commit that referenced this pull request Apr 26, 2018
…3027)

This commit adds a build target, diff, that can create a diff output of assemblies from

1. files
2. directories
3. nuget packages
4. github commits

It uses Progress/Telerik's JustAssembly command line tool to generate an XML file of the public diffs between two assemblies, with functions implemented to transform XML to markdown and asciidoc. Since JustAssembly installation cannot be easily automated, an exception is thrown when diff is run if the tool is not installed, prompting the user with a link to download.

When specifying directories or nuget packages, the assemblies within the first path will be paired up with assemblies with the same name in the second path, and a diff will be generated for each pair.

The diff can output XML, Markdown and Asciidoc, with the latter two implemented as functions that convert the XML to a document structure.

Add skipdocs argument to be able to skip generating documentation.

(cherry picked from commit e0a42a5)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants