-
Notifications
You must be signed in to change notification settings - Fork 177
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
Added a step of skipping package json update for spring boot packages #1274
Conversation
Can you please link to the issue that this is trying to address? |
@weshaggard I have updated the description of the PR. The issue I linked proposed another approach. I have talked to @scbedd about this option. Also, will sync with Spring team about the PR |
The following pipelines have been queued for testing: |
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.
This definitely works for now.
In the near future, we need to rework this. I'm thinking that we set the common CIConfig
that contains targeting, target documentation repository, which update is enabled, etc in LanguageSettings.ps1
, then support an override config all the way from the artifact level.
We'll be able to eliminate a ton of arguments and really simplify the build yml.
@scbedd Good suggestions! Per our discussions offline, we would like to push the changes for quick fix, and unblock Spring team to update the reference toc. Here is the issue for follow up work: #1276 |
Hello @azure-sdk! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
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 updatingpackage.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