История

monojenkins 4099f74d83 [apidiff] Keep the same guid when updating markdown documents (#5977 ) We often (e.g. previews, service releases) update the API diff during a release cycle. The current code generated a new GUID every time, which is not what correct since it's the same document. This uses an MD5 digest of the filename as the source of the GUID so it will remain constant once created (and updated).		2019-05-01 20:19:06 -04:00
..
.gitignore	[api-diff] Remove apidiff XML reference files. Fixes #4891 (#5663 )	2019-02-27 08:59:53 -05:00
Makefile	[apidiff] Make temporary / stamp paths depend on APIDIFF_DIR. Fixes maccore#1522. (#5895 )	2019-04-12 15:31:27 +02:00
README.md	[apidiff] Fix the comparison with the previous commit (#5690 )	2019-02-28 20:49:10 -05:00
merger.cs	[apidiff] Keep the same guid when updating markdown documents (#5977 )	2019-05-01 20:19:06 -04:00

README.md

New Releases

Inside Make.config update the APIDIFF_REFERENCES= line to point to the bundle.zip URL of the currently stable version. E.g.

APIDIFF_REFERENCES=https://bosstoragemirror.blob.core.windows.net/wrench/jenkins/d15-9/2dc06c712629feeb179ed112a590d9922caac6e7/53/package/bundle.zip

New Revisions

On the bots each revision rebuilds every assemblies. Each of them will be compared to the downloaded stable version from APIDIFF_REFERENCES. Any changes (addition/removal) to the public API will be reported in HTML files.

This can be done manually with make. The .\diff\ directory will contain the diffs in HTML format.

The helper make merge target creates a single api-diff.html file (from all the diff\*.html files) that be used for the documentation web site.