Skip to content

Commit

Permalink
Added a step of skipping package json update for spring boot packages (
Browse files Browse the repository at this point in the history
…#1274)

**Issue to solve**: Spring boot starter packages has no API documentations, so the Java Doc CI build failed to retrieve the documentation. Synced with Spring team, they expect to have readme only in Overview page without API. 
e.g: https://review.docs.microsoft.com/en-us/java/api/overview/azure/spring-boot-starter-cosmos-readme-pre?view=azure-java-preview&branch=smoke-test

Currently, we manually do the updates. 

**Purpose of the PR**: Add a variable which passes through `ci.yml` to skip updating `package.json`, so we only update readme through the release pipeline. That's how we pass the Java CI build and achieve the purpose of displaying readme only in Dos.Ms for spring boot starter packages.

Tested PR: Azure/azure-sdk-for-java#18077
Tested in pipeline: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=650940&view=logs&j=df6dbc9d-9cb6-55ac-00c8-bc457d14297a&t=df6dbc9d-9cb6-55ac-00c8-bc457d14297a

The PR generated by pipeline: https://github.com/Azure/azure-docs-sdk-java/pull/1571/files
  • Loading branch information
sima-zhu authored Dec 11, 2020
1 parent 0a64d01 commit e4bd2be
Showing 1 changed file with 2 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ parameters:
GHTeamReviewersVariable: '' # externally set, as eng-common does not have the identity-resolver. Run as pre-step
OnboardingBranch: ''
CloseAfterOpenForTesting: false
SkipPackageJson: false

steps:
- pwsh: |
Expand Down Expand Up @@ -65,7 +66,7 @@ steps:

- task: PowerShell@2
displayName: 'Update Docs.MS CI Targeted Packages'
condition: and(succeededOrFailed(), eq('${{ parameters.OnboardingBranch }}',''))
condition: and(succeededOrFailed(), eq('${{ parameters.OnboardingBranch }}',''), ne('${{ parameters.SkipPackageJson }}', true))
inputs:
targetType: filePath
filePath: ${{ parameters.ScriptDirectory }}/update-docs-ci.ps1
Expand Down

0 comments on commit e4bd2be

Please sign in to comment.