search: json encode repo metadata for csv export#59334
Conversation
|
Codenotify: Notifying subscribers in CODENOTIFY files for diff 341998d...b5987a5.
|
jtibshirani
left a comment
There was a problem hiding this comment.
Do you think we could just replace "Repository metadata" to keep the output clean? It seems like a low probability someone would have a script relying on the contents of this column?
I was on the fence about this one as well. If you look at my commits, my first version was just replacing the field. However, I know of at least 2 customers that rely on this field. I don't know whether they use a script or whether it is all just manual. Would it be acceptable to add a deprecation notice to the changelog and remove the old field in 2 releases? |
I see, that's what I was wondering about. Then your approach makes sense to me to just deprecate it for now. |
Based on customer feedback, we replace the line separated list of metadata with a json object.
112b7b0 to
6f034bd
Compare
We received the feedback that it is not always obvious that metadata is line-separated in the CSV export of search results. Depending on the tool used to display the CSV, only the first metadata value might be visible. Additionally the current format can be hard to parse.
Here we add a new column "Repository metadata JSON" to the CSV export of search results, which encodes metadata into a single line JSON. While we deprecate "Repository metadata", it will remain available for a limited time to ensure backward compatibility and a smooth transition for existing users.
example.csv
Test plan