[Build] Fix apidocs pipeline (template repo, DocsApiLevel, JAVA_HOME)#11199
Open
jonathanpeppers wants to merge 4 commits intomainfrom
Open
[Build] Fix apidocs pipeline (template repo, DocsApiLevel, JAVA_HOME)#11199jonathanpeppers wants to merge 4 commits intomainfrom
jonathanpeppers wants to merge 4 commits intomainfrom
Conversation
…eline Without an explicit ref, Azure DevOps resolves to refs/heads/release in the MicroBuildTemplate repo, where v1/1ES.Official.PipelineTemplate.yml no longer exists. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Pins the 1ESPipelineTemplates/MicroBuildTemplate repository resource used by the API docs Azure DevOps pipeline to a stable tag so the referenced v1/1ES.*.PipelineTemplate.yml templates resolve correctly.
Changes:
- Add
ref: refs/tags/releaseto the1esPipelinesrepository resource in the apidocs pipeline.
…dTemplate The MicroBuildTemplate repo has been deprecated and no longer contains the v1/ template files. The templates now live in the 1ESPipelineTemplates/1ESPipelineTemplates repo. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
changed the title
This comment was marked as outdated.
This comment was marked as outdated.
…value DocsApiLevel was hardcoded to 36, but AndroidApiLevel is now 36.1. This caused _RunMdoc to look for assemblies in the 36.1/ directory while _UpdateExternalDocumentation built them into 36/, resulting in 'No assemblies specified' from mdoc. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
The pipeline was using useAgentJdkPath: false which sets JAVA_HOME to ~/android-toolchain/jdk-17, a path that no longer exists on the Mac build agents. Switch to the default (useAgentJdkPath: true) to use the agent's preinstalled JDK instead. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
changed the title
jonathanpeppers
added
the
ready-to-review
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes multiple issues preventing the apidocs pipeline (definitionId 15262) from running on
main:1. Template repo migration
The
MicroBuildTemplaterepo in1ESPipelineTemplateshas been deprecated — all its refs point to a commit that no longer contains thev1/template files:Fix: Update the repository resource from
MicroBuildTemplateto1ESPipelineTemplatesand pin torefs/tags/release.2. DocsApiLevel hardcoded to 36
DocsApiLevelwas hardcoded to36, butAndroidApiLevelis now36.1. This caused a path mismatch:_UpdateExternalDocumentationbuilt assemblies into the36.1/output directory, but_RunMdoclooked for them in36/, resulting inmdoc: No assemblies specified.Fix: Default
DocsApiLevelto$(AndroidApiLevel)so it stays in sync.3. Invalid JAVA_HOME path
The pipeline set
useAgentJdkPath: false, which pointedJAVA_HOMEto~/android-toolchain/jdk-17— a path that no longer exists on the Mac build agents. This caused the Gradle-basedmanifestmergerbuild to fail.Fix: Remove the
useAgentJdkPath: falseoverride to use the agent's preinstalled JDK (the default behavior).