Update json files which combine config jsons and csv #2272
Conversation
| @@ -1,6 +1,17 @@ | |||
| { | |||
| "Name": "Azure.AI.FormRecognizer", | |||
| "Version": "4.0.0", | |||
| "sdkCSV": { | |||
There was a problem hiding this comment.
Why have this nested instead of having the properties directly on the object?
There was a problem hiding this comment.
I am thinking to loop into sdkCSV everytime we update from csv files in docindex. So we don't need to worry about which field takes precedence, like the field isNewSDK, type, these are duplicated fields in metadata and csvFile.
The only field I combined is version. I will compare metadata json and csv version and fill with whichever the latest.
Daily docs will use the DevVersion field in metadata jsons.
There was a problem hiding this comment.
Doesn't that just move the work that needs to figure out what takes precedence? We would need to interpret that at some point.
There was a problem hiding this comment.
Two situations here:
- Release pipeline will update docs metadata most up-to-date. So in this case, I'd take the value from docs metadata.
- For the package out of release pipeline, I'd take the value from csv files.
If we leave one for each field only, then in docindex pipeline we need to figure out whether we override or not. I don't think it is easy to decide.
For example, Microsoft.Azure.Storage.Blobs are outside of release pipeline, so it will look like
{
Name: Microsoft.Azure.Storage.Blobs,
Version: 1.1.1,
Type: client,
New: true;
}
In docindex, we are lack of ability to determine whether to update type and new from csv file. (docindex can't tell if it is from release pipeline or not)
If we use sdkCSV, then we can blindly update the block as the json will look like:
{
Name: Microsoft.Azure.Storage.Blobs,
Version: 1.1.1,
sdkCSV: {
Type: client;
New: true;
}
}
When we need to use type and new info for filter or toc updates, we can take the out layer block value first, if no such fields, then take inner block value.
|
Learn Build status updates of commit 6b3e2b6:
|
|
Learn Build status updates of commit 6fb5012:
|
|
Learn Build status updates of commit f2c2fe7: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Learn Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
|
Learn Build status updates of commit 2ee1463: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Learn Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
|
Learn Build status updates of commit 211fba4: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Learn Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
sima-zhu
force-pushed
the
metadata_update
branch
from
211fba4
to
9a6b76d
Compare
|
Learn Build status updates of commit 9a6b76d: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Learn Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
What we are doing in this PR
This is one-time batch work. This is a pre-requisite step before we update the docindex pipeline onboarding logic.
We will use docs metadata jsons as our source to update the config jsons.
Things will do after check-in this PR
In release/nightly pipeline, they will update the metadata jsons as needed.
In docindex, we will update metadata with
versioninfo andsdkCSVblock.version, main branch will take whatever the latest. daily branch will take version inDevVersionfrom metadata json.sdkCSV, we only update docs related fields,DisplayName,ServiceName,Type,New,RepoPath,Support,EOLDate,Hide,MSDocService.In docindex, after update from csv, we will add a step to write whatever we need back to config json files. (e.g. azure-dotnet.csv)