Document behavior of SDK generation script

[despadam]

When changes are added to master but have not been released yet, in order to develop locally with the latest SDK, one can use npm run generate:sdk:local inside the frontend container.

When trying to execute, I got re-directed to run this command instead:

Your environment is a linux/unix
Please run the following command on your terminal:
> sudo -E ./scripts/generate-nestjs-sdk.bash

which should be executed outside the container.

This command worked after ensuring that my frontend container runs on node v18, otherwise the node_modules folder could not get populated.

---

Is the SDK generation documented somewhere? Is the script generic enough to ensure that it would work if not for all then at least for most cases?

[bpedersen2]

I took a look at the scripts involved:

The only reason the script is run as root under linux is the use of docker got the openapi calls.
If you are running it as a user with docker access I think it would be easy to run the container directly as the correct user, so the need for root would get away.

I'll see if I can come up with solution.

[martin-trajanovski]

I took a look at the scripts involved:

The only reason the script is run as root under linux is the use of docker got the openapi calls. If you are running it as a user with docker access I think it would be easy to run the container directly as the correct user, so the need for root would get away.

I'll see if I can come up with solution.

Thanks for the investigation @bpedersen2. I am running everything on windows and didn't have a real chance to test it properly on a linux environment. I know @Junjiequan and @nitrosx were testing on their end using different operating systems and that's why we did some modifications that were needed. But it will be more than appreciated if you can come up with a better solution that works in this case.