sandrokeil/citools

Composer meta package of QA tools for Travis, Coveralls and Scrutenizer

2.0.0 2015-01-19 22:14 UTC

Requires

• php: ~5.3
• phpmd/phpmd: ~2.0
• phpunit/php-invoker: ~1.1
• phpunit/phpunit: ~4.1
• satooshi/php-coveralls: ~0.6
• squizlabs/php_codesniffer: ~2.0

BSD-3-Clause

• Sandro Keil

• php
• ci
• tools
• travis
• qa
• coveralls
• scrutenizer
• badges

README

You want one repository which loads common PHP QA tools?

You want examples of all the beautiful services around GitHub for PHP analysis?

You want to be a badge poser?

This module comes to the rescue!

The composer.json contains definitions of QA tools for Travis-CI, Coveralls and Scrutinizer integration. So it's really easy to integrate these tools.

Installation

Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.

Put the following into your composer.json

{
    "require-dev": {
        "sandrokeil/citools": "~2.0"
    }
}

Documentation

See .travis.yml, .scrutinizer.yml and phpunit.xml.dist for an example configuration. See also Bootstrap.php to initalize your ZF2 project for your tests.

Continuous Integration/Inspection tools

Register your repository on these services for PHP analysis.

• Travis-CI
• Scrutinizer
• Coveralls
• VersionEye
• SensioLabsInsight
• PHP-CS-Fixer

Integrated libraries

These PHP libraries are used to generate reports for above services.

• phpunit/phpunit
• phpunit/php-invoker
• phpmd/phpmd
• squizlabs/php_codesniffer
• satooshi/php-coveralls

Additional badges

All continuous integration/inspection tools have its own badges but if you want to be a badge poser, here are more.

• Packagist - Register your repository here and other services will use it
• HHVM Status - HHVM support badge
• Badge Poser - Several badges depending on repository
• Shields.io - Custom badges
• Still Maintained - Finally a place to mark your open source project as abandoned or looking for a new maintainer
• Issuestats.com Analyze and compare how long it takes for GitHub issues to be closed

Application access

Some CI tools need access to your repository. Sign in with your GitHub login to grant access to your repository. Here is a list of webhooks and services which need access to your repository.

Webhooks

• https://scrutinizer-ci.com/github-callback (automatically created)
• https://insight.sensiolabs.com/api/analyze-scm (automatically created)

Services

• Packagist (must be created manually, please follow instructions on the website)
• Travis CI (must be created manually, please follow instructions on the website)