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

Use the batch version of ValidateDocsMsPackagesFn #3169

Merged
2 commits merged into from
Apr 20, 2022

Conversation

hallipr
Copy link
Member

@hallipr hallipr commented Apr 19, 2022

Refactor Update-DocsMsMetadata.ps1 to support batch processing in $ValidateDocsMsPackagesFn

It appears that only azure-sdk-for-java and azure-sdk-for-python implement $ValidateDocsMsPackagesFn. Both repos have been updated to support the -PackageInfos parameter to $ValidateDocsMsPackagesFn

@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

foreach ($packageInfoLocation in $PackageInfoJsonLocations) {
Write-Host "Updating metadata for package: $packageInfoLocation"
# Convert package metadata json file to metadata json property.
$packageInfo = GetPackageInfoJson $packageInfoLocation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cannot remove this without breaking the other languages until they each are updated to start passing in this new parameter. What is our transition plan?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each of the language-settings files that implemented $ValidateDocsMsPackagesFn have been shimmed to support single packageInfo and multiple packageInfos parameters:
Azure/azure-sdk-for-js#21483
Azure/azure-sdk-for-java#28346
Azure/azure-sdk-for-python#24041

Copy link
Member Author

@hallipr hallipr Apr 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The yaml and powershell script for Update-DocsMsMetadata already supported multiple package info locations. The implementation steps are:

  1. Add batch support to the language repos (language repo prs)
  2. Add batch invocation to eng/common (this pr)
  3. Optimize batch processing per language
    • Pass multiple packageInfoLocations to update-docsms-metadata.yml
    • Use deeper batch processing in Validate-{language}-DocMsPackages

@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

@ghost
Copy link

ghost commented Apr 20, 2022

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 c5408d2 into main Apr 20, 2022
@ghost ghost deleted the hallipr/batch-docsms-validation branch April 20, 2022 22:34
benbp pushed a commit to benbp/azure-sdk-tools that referenced this pull request May 6, 2022
Refactor `Update-DocsMsMetadata.ps1` to support batch processing in `$ValidateDocsMsPackagesFn`

It appears that only azure-sdk-for-java and azure-sdk-for-python implement `$ValidateDocsMsPackagesFn`.  Both repos have been updated to support the `-PackageInfos` parameter to `$ValidateDocsMsPackagesFn`
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants