Should mf-types be committed to source control?

[nickhall]

Judging by the content and volatile nature of mf-types, I would assume that it should be left out of version control. But if you don't include it, then processes like running type checking in CI environments, which just operate on the plain source code, fail because modules for the imported remotes cannot be found.

What's the official guidance around this? Should I actually be committing these types?

[YanPes]

Some of the examples in the official repository contain the @mf-types dir.

There is no specific doc on best practices for DTS.

Currently, I commit them to bypass the issues on CI side.

@ScriptedAlchemy do you have some guidance here?

[nickhall]

Well, I gave it a try and it turns out it was a different problem. The build on the CI server is just not fetching the remote types for some reason, although it works locally. If I SSH into the CI machine I can manually grab the manifest. Committing the types would fix it, but now I'm curious why it's not downloading them.

[YanPes]

When you check your build you will see some logging telling you that "federated types generated successfully" on your local env. This is done pretty late within the build process so I bet your TS in the ci build is yelling before the types are generated in the first place. If you commit the files TS is pleased and everything will compile as expected

[nickhall]

Thank you both. I tried completely delaying the tsc call until after the webpack build completed but it looks like it's not working. I do see the "federated types extraction completed" logs but no @mf-types. I'll dig into it a bit more.

[YanPes]

Can you paste the error message? Also you were referring to ssh'ing to the dir. Are you running on docker?

[ScriptedAlchemy]

You need to ensure that types zip file that we emit is uploaded along with your build as well. If it's not then that might be the problem. No type is hosted on the internet for CI to grab vs locally if you have local server running and it can get it from there?