[ci] Add pipeline for updating api docs #6460
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
Comment on lines
+4
to
+5
| trigger: none | ||
| pr: none |
Member
There was a problem hiding this comment.
So is the plan to just run this every now and then? Should we make a document that says how to do it?
Member
Author
There was a problem hiding this comment.
Yeah, my thinking was that every time we get a new binding version or fix something in the javadoc transformation we could use this to build a new set of docs. Eventually the pipeline could create a PR into android-api-docs, but I don't think that's necessary for now (at least not until xamarin/android-api-docs#26 and some other low hanging fixes have landed).
jonathanpeppers
approved these changes
Nov 4, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces a new
azure-pipelines-apidocs.yamlpipeline that can beused to update the Mono.Android docs in the xamarin/android-api-docs
repository. We will now only build Mono.Android with generated JavaDoc
xml when running this new pipeline. The pipeline will run the
<UpdateExternalDocumentation/>target and upload the contents of/android-api-docs/docs/Mono.Android/en/ as a build artifact. These
updated docs can be downloaded for manual review and pull request
creation.
The .NET 6 packs have been updated to include the same Mono.Android.xml
docs that are bundled into the traditional Windows .vsix installer.
These docs are generated from the content of
external/android-api-docswhen the
<AssembleApiDocs/>installer target is ran.