xamarin-macios/tools/apidiff
Sebastien Pouliot 500b3af912
[catalyst][tools] Add Xamarin.MacCatalyst to API diff (#10762)
This is now possible since our reference is now `d16-9` which has (very
early versions of) the Xamarin.MacCatalyst (and Xamarin.iOS stubs)
assemblies.

This will become more useful when
1. bots resume the generation of commit-by-commit API diff; and
2. a real baseline is defined for the catalyst API coverage

* Add the new links to the comment done by VSTS.

Co-authored-by: Sebastien Pouliot <sebastien.pouliot@microsoft.com>
Co-authored-by: Manuel de la Pena <mandel@microsoft.com>
2021-03-03 19:41:00 -05:00
..
.gitignore [catalyst][tools] Add Xamarin.MacCatalyst to API diff (#10762) 2021-03-03 19:41:00 -05:00
Makefile [catalyst][tools] Add Xamarin.MacCatalyst to API diff (#10762) 2021-03-03 19:41:00 -05:00
README.md [apidiff] Fix the comparison with the previous commit (#5690) 2019-02-28 20:49:10 -05:00
diff-bundles.sh [apidiff] Add q quick'n'dirty script to produce a diff between any two bundle.zip (#6050) 2019-05-15 12:46:38 -05:00
merger.cs [apidiff] Fix range expression. (#8827) 2020-06-11 11:44:39 +02: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.