badgess v1.0.3
Badges, Badges, Badges, Badges ...
Tutorial when creating a new repo and want to use badges ;-)
#Build Process
I choosed Travis CI, its free for open/public repos. What is Travis: In software development, Travis CI is an open-source hosted, distributed continuous integration service used to build and test projects hosted at GitHub. Travis CI is configured by adding a file named .travis.yml, which is a YAML format text file, to the root directory of the GitHub repository.
More in Travis CI
##Adding the npm task for travis-ci
Travis CI runs npm test after it fetched your project and installed the dependencies, so we need to add this task to the package.json file.
"scripts": {
"test": "grunt default --verbose"
}I’ve added the --verbose option, so we’ll see more output of what is going on.
##Adding the .travis.yml Every Travis CI project needs to have a .travis.yml file in the root of the project folder, so it know what platform and version it should use to build/test your project. Here’s the one I used:
language: node_js
node_js:
- "0.10"After these changes your project is ready to be continuously builded with Travis CI.
But don’t forget to setup the Service Hook on Github!
Now You can use the build status badge: Read more in here
#Code Analysis
I'm using Code Climate
What is Code Climate: Code Climate hosted software metrics help you ship quality Ruby, PHP and JavaScript code faster. Get control of your technical debt with real time static ...
They use GPA fro their metrics: Learn more about their GPA (grade point average)
#Coverage
I'm using coveralls, coveralls can work soomtly with Travis-ci, in order to submit yor coverage to coveralls, I'm integrating in my GruntFile the following: 1. mocha-lcov-reporter - This will report from mocha to the target file 2. grunt-coveralls - This will submit the coverage result to coveralls
#Badges Dependencies
I recommend david-dm.org.
David is free for public projects on Github.
David gets you an overview of your project dependencies, the version you use and the latest available, so you can quickly see what's drifting. Then it's all boiled down into a badge showing the current status, which you can embed on your site
Declare your dependencies in a package.json file and you're good.