Add Travis CI and CodeClimate to this repo

unicef / magicbox-maps-prototype

Suggest schools and regions most in need of infrastructure and planning for disaster prevention and response

4 stars 5 forks source link

Add Travis CI and CodeClimate to this repo #10

Open thoat opened 6 years ago

jwflory commented 6 years ago

As a note, a nice sub-task for this would be to also finish the documentation for TravisCI and CodeClimate (see here). I didn't have a chance to finish it during my internship and I wanted to swing back around to it, but I haven't had a chance to yet. If you are going through the process, it would probably help to document it as you go while it's fresh in mind. :slightly_smiling_face:

thoat commented 6 years ago

Via these commits (dc0869ed2c5accf5ae44c90a270ec154c72e416d, 658450259487b0436696642c401fe605c4804166, 22a1c3ba3bd38e7504ac2f1460ce4c67cd2522cb, and f254975a2b1cc385d075469abc99d3963a6bc605), I have added very basic Travis CI and CodeClimate (both maintainability and test coverage reporting) to this repo.

thoat commented 6 years ago

Update: I don't think the setup for CodeClimate test coverage reporting is complete yet and I'd love to come back to this task some time soon.

What's done:

Add the CC_REPORTER_ID and the scripts to .travis.yml
Add the Test Coverage badge to README

What's next:

Find a compatible testing framework for our projects and set that up. CodeClimate will read results from there and hence able to automate and display the test coverage percentage and status.

Besides, our dev's will need to improve our testing in the code as a long term move.

jwflory commented 6 years ago

According to the CodeClimate supported languages and formats, the only supported JavaScript coverage tool is lcov. My understanding is Istanbul can be used to generate lcov-friendly output.

With Istanbul, you can generate test coverage reports that look something like this. More information is available in the Istanbul README.