Skip to content
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

Merged
3 commits merged into from
Dec 11, 2020

Conversation

sima-zhu
Copy link
Contributor

@sima-zhu sima-zhu commented Dec 10, 2020

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

@sima-zhu sima-zhu added Central-EngSys This issue is owned by the Engineering System team. EngSys This issue is impacting the engineering system. labels Dec 10, 2020
@sima-zhu sima-zhu marked this pull request as ready for review December 11, 2020 16:36
@sima-zhu sima-zhu requested a review from a team as a code owner December 11, 2020 16:36
@sima-zhu sima-zhu requested review from scbedd and removed request for a team December 11, 2020 16:37
@weshaggard
Copy link
Member

Can you please link to the issue that this is trying to address?

@sima-zhu
Copy link
Contributor Author

sima-zhu commented Dec 11, 2020

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

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

Copy link
Member

@scbedd scbedd left a 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.

@sima-zhu
Copy link
Contributor Author

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

@ghost
Copy link

ghost commented Dec 11, 2020

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

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 (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit e4bd2be into Azure:master Dec 11, 2020
@sima-zhu sima-zhu deleted the skip_packge_json branch December 13, 2022 00:33
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. EngSys This issue is impacting the engineering system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants