Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.

MIT License

2.1k stars 1.21k forks source link

[digitaltwins] Failing build:samples scripts #12729

Closed willmtemple closed 3 years ago

willmtemple commented 3 years ago

Sample Quality Effort

This issue was created because one or more packages in the digitaltwins service directory had failing build:samples NPM scripts, and I determined that the existing script was broken and could not work, or would take extra effort to repair. #12715 (Build Samples in PR CI) will replace the broken script with a placeholder that simply executes echo Skipped..

The packages in question are:

@azure/digital-twins-core

Usually, these errors were caused by faulty assumptions, such as:

a script that executes cd samples && tsc -p ., but with no tsconfig.json or other required files in the samples folder
use of old samples scripts that no longer exist
use of new samples scripts (dev-tool) without a correct samples folder layout (e.g. missing typescript subfolder)

What do I do about this?

See #14470

witemple-msft commented 3 years ago

@zolvarga Do you have any thoughts on this? We rely on samples to be organized according to a particular convention, and it seems like the samples for digitaltwins aren't written in TypeScript. Before we can get the digitaltwins samples validating in CI, we'll need to convert them to TypeScript first.

deyaaeldeen commented 3 years ago

@zolvarga I also opened this issue https://github.com/Azure/azure-sdk-for-js/issues/13295 based on feedback from @kartben

zolvarga commented 3 years ago

@witemple-msft

Writing typescript samples in our backlog. The @azure/digital-twins-core package not intended to contain samples, so I don't think this is an error. I would close this issue following the first point in your notes.

What do you think?

Zoltan

ramya-rao-a commented 3 years ago

@zolvarga If the @azure/digital-twins-core package is not intended to contain samples, what purpose do the current set of samples serve?

ramya-rao-a commented 3 years ago

cc @sharmasejal, @anthonyvercolano as requested

witemple-msft commented 3 years ago

This issue has been superseded by #14470. There is a new samples workflow enabled in the repo, so whatever action we decide to take on this package (whether it's removing the existing sample set or rewriting them in TypeScript), it should be done with the migration to Samples V2 in mind.