ember-cli-addon-docs
ember-cli-addon-docs copied to clipboard
ember-learn
Consider running tests on Windows
The company I work for uses Windows, and we've been using ember-cli-addon-docs to document an internal addon. It is pretty evident that this code-base has not been run on Windows by the developers before. This is fair, but ultimately problematic. Ember-cli-addon-docs is increasingly used by addons across the ecosystem, essentially locking Windows users out of contributing to their documentation unless they are familiar with common issues and can debug/fix them.
We got it to work for us (although there are still rough edges), but I think this is something that will continue to break if Windows support is not part of every PR review. For this reason I propose running the test suite on Windows as well, for example using Appveyor. This is free for open source projects, just like Travis.
Please let me know what you think.
Hey, @joukevandermaas, I've just run into #427 on Windows.
Can you please share the hacks and fixes that you have applied?
@lolmaus we decided not to use github pages because (1) this was an internal addon and we already have deployment infrastructure and (2) I couldn't be bothered to figure out the "happy path" given the issues you mention.
At the company I work for we're also trying out running a Linux VM on Windows (some people use WSL2, some just a VM) and using that for development (using the VS Code container extension). It doesn't take that long to set up, and it's promising so far. See this link for the setup I personally use.
I know this is not a great answer ("just use linux anyway :smile:") but it's all I have, sorry.
I'm not familiar with Windows or what issues might be occurring. If you guys know of fixes and/or wanted to help us setup Windows tests, that would be great!
@joukevandermaas @lolmaus would either of you be able to elaborate on the issues you encountered? I'm thinking we should move the build to GitHub actions and run on Mac, Windows, and Linux.