Skip to content

A github integration which displays linter results generated by Travis as a commit/PR status

Notifications You must be signed in to change notification settings

quinkennedy/travis-github-lint-status

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a GitHub integration powered by Travis-CI

Why

I wanted to separate Linter results from Test results. I don't believe that continuous integration should fail because of simple linting errors. This module is meant to post Linter results as a separate Status line on a GitHub commit or Pull Request.

Example

Limitations

This module assumes you are working with Travis for CI, GitHub for SCM, and ESLint for linting. Pull requests welcome to extend support.

When linting, the module acts the same as if you called eslint . in your project root.

Setup

First you will need to create a Personal Access Token with the repo:status permission. Add your generated token to your repository's Environment Varibles in Travis-CI as TRAVIS_GITHUB_LINT_STATUS_TOKEN. You can access the Environment Variables in Travis-CI by going to your repository's Settings page on the Travis-CI website.

Next you will need to load this module during your Travis-CI execution. In your install section add npm install travis-github-lint-status. If you don't have an install section, you will need to add one (example in YAML):

install:
  - npm install;
    npm install travis-github-lint-status;

Then the actual call in the script section (again in YAML, replace npm run coverage with whatever your standard CI run script is):

script:
  - ./node_modules/travis-github-lint-status/index.js
    npm run coverage;

Notes

This module should only be run once per commit or pull-request. If your CI is configured to test on multiple platforms or Node versions, you should make sure this module only runs in one particular configuration.

An example:

language: node_js
node_js:
  - "node"
  - "4"
  - "0.12"
os:
  - linux
  - osx
install:
  - npm install;
    npm install travis-github-lint-status;
script:
  - if [ "$TRAVIS_OS_NAME" == "linux" ] && [ "$TRAVIS_NODE_VERSION" == "node" ]; then
    ./node_modules/travis-github-lint-status/index.js;
    fi;
    npm run coverage;

In The Wild

Feel free to explore the pull request statuses, commit statuses, and Travis-CI configs of the following projects:

About

A github integration which displays linter results generated by Travis as a commit/PR status

Resources

Stars

Watchers

Forks

Packages

No packages published