ember-learn / ember-learn/ember-cli-addon-docs

Consider running tests on Windows

Open
#385 6 comments 2 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
172
Forks
142
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start by examining the repository's existing test command and CI configuration, then investigate how Appveyor could run the test suite on Windows. Check the suite in a Windows environment for failures and rough edges; done means Windows test runs are included in PR validation and the existing tests pass there.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
ci-cd, operating-systems, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.