[DO NOT MERGE] Initial check-in for supporting telemetry in vscode #6123
Conversation
RodgeFu
requested review from
bterlson,
markcowl,
allenjzhang,
timotheeguerin,
chrisradek,
AlitzelMendez and
witemple-msft
as code owners
|
All changed packages have been documented.
|
|
You can try these changes here
|
| @@ -10,6 +10,9 @@ jobs: | |||
| parameters: | |||
| useDotNet: true | |||
|
|
|||
| - script: pnpm run update-telemetry-key $(vscode-telemetry-key) | |||
| workingDirectory: $(Build.SourcesDirectory)/packages/typespec-vscode | |||
|
|
|||
There was a problem hiding this comment.
@timotheeguerin , I need to update the telemetry-key to the PROD one when publishing vscode extension. Do you know how I can add the PROD key into the $(vscode-telemetry-key) varaible? And how can I test whether the updated pipeline works without actually doing a publish? thanks.
There was a problem hiding this comment.
does the key need to be private? our others don't as they can't be kept private anyway(and I assume this one neither)?
There was a problem hiding this comment.
no, it doesn't need to be private.
There was a problem hiding this comment.
I’d say I would include them both right there then and just decide with a .env which one should be used.
There was a problem hiding this comment.
Talked with guys from AzureApiCenter vscode extension team. Although it's not sensitive and will be in the released package.json eventually, but they still store the key as secret var in pipeline instead of plain text in github (https://github.com/microsoft/vscode-azureapicenter/blob/dev/.github/workflows/cd.yml#L39-L44). I'm also more comfortable not to store PROD "key" as plain text in github and prefer to follow what they are doing.
I gave it a try and was able to add a secret to the "typespec -Publish" pipeline for the key successfully (https://dev.azure.com/azure-sdk/internal/_apps/hub/ms.vss-build-web.ci-designer-hub?pipelineId=3226&nonce=wqPmyYzOeUiSS5fefsbaeA%3D%3D&branch=main). Do you know how I can test the change without actually publish something? Do I have to comment the publish part, test and then uncomment...? thx
RodgeFu
changed the title
Support telemetry in vscode. fixes #5298
DO-NOT-MERGE until we finish the privacy review.