xamarin-macios/tools/apidiff/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.
[apidiff] Add build reminder to README 2018-05-30 23:33:13 +03:00			`# New Releases`

[apidiff] Fix the comparison with the previous commit (#5690) The removal of the XML files broke the comparison with the previous commit. It did NOT fail the original PR because the targets were in the previous commit. And it will fail this PR because the previous commit still does not have the targets - but it _should_ be fine, once merged, for all future PR. Fixes https://github.com/xamarin/maccore/issues/1452 2019-03-01 04:49:10 +03:00			Inside `Make.config` update the `APIDIFF_REFERENCES=` line to point to the `bundle.zip` URL of the currently stable version. E.g.
Add apidiff tool. 2016-04-21 16:06:16 +03:00
[apidiff] Fix the comparison with the previous commit (#5690) The removal of the XML files broke the comparison with the previous commit. It did NOT fail the original PR because the targets were in the previous commit. And it will fail this PR because the previous commit still does not have the targets - but it _should_ be fine, once merged, for all future PR. Fixes https://github.com/xamarin/maccore/issues/1452 2019-03-01 04:49:10 +03:00			```
			`APIDIFF_REFERENCES=https://bosstoragemirror.blob.core.windows.net/wrench/jenkins/d15-9/2dc06c712629feeb179ed112a590d9922caac6e7/53/package/bundle.zip`
			```
Add apidiff tool. 2016-04-21 16:06:16 +03:00
[apidiff] Add build reminder to README 2018-05-30 23:33:13 +03:00			`# New Revisions`
Add apidiff tool. 2016-04-21 16:06:16 +03:00
[apidiff] Fix the comparison with the previous commit (#5690) The removal of the XML files broke the comparison with the previous commit. It did NOT fail the original PR because the targets were in the previous commit. And it will fail this PR because the previous commit still does not have the targets - but it _should_ be fine, once merged, for all future PR. Fixes https://github.com/xamarin/maccore/issues/1452 2019-03-01 04:49:10 +03:00			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.
Add apidiff tool. 2016-04-21 16:06:16 +03:00
			This can be done manually with `make`. The `.\diff\` directory will contain the diffs in HTML format.

[apidiff] Add build reminder to README 2018-05-30 23:33:13 +03:00			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.