-
Notifications
You must be signed in to change notification settings - Fork 564
[ci] Add pipeline for updating api docs #6460
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Pipeline for updating and uploading android-api-docs/docs/Mono.Android/en/* | ||
| # https://dev.azure.com/devdiv/DevDiv/_build?definitionId=15262 | ||
|
|
||
| # This pipeline can be manually ran against a given branch to generate a new set of Mono.Android docs. | ||
| # The `Mono.Android Docs` artifact can be downloaded and copied into a local android-api-docs checkout | ||
| # for manual review and pull request creation. | ||
|
|
||
| trigger: none | ||
| pr: none | ||
|
|
||
| # Global variables | ||
| variables: | ||
| - template: yaml-templates/variables.yaml | ||
|
|
||
| stages: | ||
| - stage: mac_build | ||
| displayName: Build | ||
| dependsOn: [] | ||
| jobs: | ||
| - job: mac_build_update_docs | ||
| displayName: Update API Docs | ||
| pool: | ||
| vmImage: macOS-11 | ||
| timeoutInMinutes: 120 | ||
| workspace: | ||
| clean: all | ||
| steps: | ||
| - checkout: self | ||
| submodules: recursive | ||
|
|
||
| - script: echo "##vso[task.setvariable variable=JI_JAVA_HOME]$HOME/Library/Android/$(XA.Jdk11.Folder)" | ||
| displayName: set JI_JAVA_HOME | ||
|
|
||
| - template: yaml-templates/use-dot-net.yaml | ||
|
|
||
| - task: NuGetAuthenticate@0 | ||
| displayName: authenticate with azure artifacts | ||
| inputs: | ||
| forceReinstallCredentialProvider: true | ||
|
|
||
| - template: yaml-templates/run-xaprepare.yaml | ||
| parameters: | ||
| displayName: update mono | ||
| arguments: --s=UpdateMono | ||
|
|
||
| - script: make prepare CONFIGURATION=$(XA.Build.Configuration) PREPARE_CI=1 PREPARE_AUTOPROVISION=1 | ||
| workingDirectory: $(Build.SourcesDirectory) | ||
| displayName: make prepare | ||
|
|
||
| - task: MSBuild@1 | ||
| displayName: build jnienv-gen.csproj | ||
| inputs: | ||
| solution: $(Build.SourcesDirectory)/external/Java.Interop/build-tools/jnienv-gen/jnienv-gen.csproj | ||
| configuration: $(XA.Build.Configuration) | ||
| msbuildArguments: /restore | ||
|
|
||
| - task: MSBuild@1 | ||
| displayName: update android-api-docs | ||
| inputs: | ||
| solution: $(Build.SourcesDirectory)/src/Mono.Android/Mono.Android.csproj | ||
| configuration: $(XA.Build.Configuration) | ||
| msbuildArguments: /restore /t:UpdateExternalDocumentation | ||
|
|
||
| - template: yaml-templates/upload-results.yaml | ||
| parameters: | ||
| xaSourcePath: $(System.DefaultWorkingDirectory)/xamarin-android | ||
| artifactName: Build Results - API Docs Update | ||
| includeBuildResults: true | ||
|
|
||
| - task: PublishPipelineArtifact@1 | ||
| displayName: upload Mono.Android docs | ||
| inputs: | ||
| artifactName: Mono.Android Docs | ||
| targetPath: $(Build.SourcesDirectory)/external/android-api-docs/docs/Mono.Android/en/ | ||
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1 @@ | ||
| <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"> | ||
| <a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a> | ||
| </format> and used according to terms described in the <format type="text/html"> | ||
| <a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format> | ||
| </para> | ||
| <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So is the plan to just run this every now and then? Should we make a document that says how to do it?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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).