Setup-For-CI.md

Setup Travis CI

Let's get this repository set for TravisCI so that TravisCI can run the unit/integration tests and then notify the GitHub Hooks for the same.

Steps

Setup CI using TravisCI

• Create an account on TravisCI.org
• Add your GitHub project repository from TravisCI Dashboard
• In your local repo for the same project, add a new file, .travis.yml at the root of the project folder
  • Add the langauge for your project
  • You can also add the version of your language
  • You can also add after success tasks (What to so after all the tests are successful)
    • Like we want the code coverage report once all test cases are passed
• Let's get the Badge 😍 (Don't forgot to choose the branch while checking for the badge)
• Push the changes to GitHub

Example .travis.yml file

language: node_js
node_js:
  - '8.9.3'
after_success:
  - npm install -D coveralls
  - npm run coverage
  - npm run coveralls

Setup Coveralls for Code Coverage Badge

• Go to Coveralls.io

• Add your GitHub project repo

• Click on Details, you'll get your repo token

• Scroll down further to get the Code Coverage Badge

• Choose markdown and paste the code in README.md 😍

• In your local project repo, create a .coveralls.yml

  • Add the details of .yml file you saw in Coveralls repo details

• Generating and sending report to Coveralls

  • Generate the coverage report by adding coverage NPM script:

  // add this inside the script section of `package.json`
  "coverage": "jest --coverage",

  • Add one more NPM script coveralls

  "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls",

• Push the changes to GitHub

• Note: Now go back to Coveralls.io, click on the project repo and scroll to the bottom

• Click on Refresh Button to reflect the coverage changes in the README

Example .coveralls.yml file

service_name: travis
repo_token: your_token