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

Call GetDocsMsDevLanguageSpecificPackageInfoFn if it's defined #7951

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

JimSuplizio
Copy link
Member

The GetDocsMsDevLanguageSpecificPackageInfoFn pointer was only being called if the DevVersion was set and should have been being called all the time, if the function pointer was defined. The reason for this is because the only language that had the function defined was Javascript and it only needed to be called if the DevVersion was set. As such, the fix to this file is to call it all the time and, for Javascript, the Get-javascript-DocsMsDevLanguageSpecificPackageInfo, needs to be updated to only process if the DevVersion is set.

@JimSuplizio JimSuplizio added Docs Central-EngSys This issue is owned by the Engineering System team. labels Mar 26, 2024
@JimSuplizio JimSuplizio requested a review from danieljurek March 26, 2024 18:53
@JimSuplizio JimSuplizio self-assigned this Mar 26, 2024
@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

@danieljurek danieljurek left a comment

Choose a reason for hiding this comment

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

Before this change merges, a JS change needs to be made. The two can merge at roughly the same time as long as the PRs merge before docindex runs for the day.

The $GetDocsMsDevLanguageSpecificPackageInfoFn function is now more universally applicable after this change. This is how it should've been to begin with.

azure-sdk added a commit to Azure/azure-sdk-for-js that referenced this pull request Mar 26, 2024
@JimSuplizio JimSuplizio merged commit 2a557f8 into Azure:main Mar 26, 2024
24 checks passed
JimSuplizio added a commit to Azure/azure-sdk-for-js that referenced this pull request Mar 26, 2024
…e-Settings.ps1 (#29075)

This change is necessary to match change in Update-DocsMsMetadata.ps1
made in [this azure-sdk-tools
PR](Azure/azure-sdk-tools#7951). The
Get-javascript-DocsMsDevLanguageSpecificPackageInfo function is the
implementation of the GetDocsMsDevLanguageSpecificPackageInfoFn. This is
something that should have been called all the time but because
javascript was the only language using this, Update-DocsMsMetadata.ps1
was only calling this if the packageInfo file's DevVersion was set.
Because this needs to be called all the time, if it's defined for a
given language, and javascript only needs process if the DevVersion is
set, move that check to the implemented function.
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. Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants