No Description

Dmitry Khomutov 11ef5ef302 Fixed Notice error. Issue #185. 2 weeks ago
app 412bedf45e Added ./app directory to Git. 1 year ago
bin 06cdf35337 Removed 'console.bat' file. 9 months ago
docs 456e2ace9b Added information about additional dependencies for some plugins 3 weeks ago
public 84b2fefd19 Now browser notifications are disabled by default. Issue #156. 1 month ago
runtime fa7a2d784b Small fix (runtime/builds dir). 3 months ago
src 11ef5ef302 Fixed Notice error. Issue #185. 2 weeks ago
tests 069026bc2d Added ability to merge in-database project config over in-repository 2 months ago
.codecov.yml c015d8c58b Refactored project structure. 3 months ago
.editorconfig 8c69129c76 Small fixes. 2 months ago
.gitignore fa7a2d784b Small fix (runtime/builds dir). 3 months ago
.php-censor.yml 95577f178a ci.php-censor.info config fixes. 1 month ago
.travis.yml 8d0d23f5f4 Merged PostgreSQL and MySQL tests inti one PHPUnit XML config. 3 months ago
CHANGELOG.md a16af8a621 Added changelog for release 0.22.0. 1 month ago
CODE_OF_CONDUCT.md 9802e2b81c Improved ISSUE_TEMPLATE.md. 3 months ago
CONTRIBUTING.md b3197b47f2 Code style fixes. 7 months ago
ISSUE_TEMPLATE.md 9802e2b81c Improved ISSUE_TEMPLATE.md. 3 months ago
LICENSE 8c69129c76 Small fixes. 2 months ago
PULL_REQUEST_TEMPLATE.md b3197b47f2 Code style fixes. 7 months ago
README.md 8c69129c76 Small fixes. 2 months ago
VERSION.md 8b487d8af2 Updated application version to 0.22.0. 1 month ago
bootstrap.php fee4b127b0 Small bootstrap.php cleanup. 3 months ago
composer.json a270c740c3 php_code_sniffer not including phpcs.xml standard 1 month ago
composer.lock b13049187e Update php_code_sniffer to ~3.2.0 1 month ago
phpmd.xml d3a390d3f8 Added status and source build fields validation. 3 months ago
phpunit.xml c015d8c58b Refactored project structure. 3 months ago

README.md

PHP Censor Travis CI SensioLabs Insight Codecov Latest Version Total downloads License

PHP Censor

PHP Censor is a open source self-hosted continuous integration server for PHP projects (PHPCI fork).

Twitter: @php_censor.

Dashboard

More screenshots.

System requirements

  • Unix-like OS (Windows isn't supported);

  • PHP 5.6+ (with OpenSSL support and enabled functions: exec(), shell_exec() and proc_open());

  • Web-server (Nginx or Apache2);

  • Database (MySQL/MariaDB or PostgreSQL);

  • Beanstalkd queue (Optional, needed if you use worker instead of cronjob);

Features

  • Clone project from GitHub, Bitbucket (Git/Hg), GitLab, Git, Hg (Mercurial), SVN (Subversion) or from local directory;

  • Set up and tear down database tests for PostgreSQL, MySQL or SQLite;

  • Install Composer dependencies;

  • Run tests for PHPUnit, Atoum, Behat, Codeception and PHPSpec;

  • Check code via Lint, PHPParallelLint, Pdepend, PHPCodeSniffer, PHPCpd, PHPCsFixer, PHPDocblockChecker, PHPLoc, PHPMessDetect, PHPTalLint and TechnicalDept;

  • Run through any combination of the other supported plugins, including Campfire, CleanBuild, CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe;

  • Send notifications on Email, XMPP, Slack, IRC, Flowdock, HipChat and Telegram;

  • Use your LDAP-server for authentication;

Installing

  • Go to the directory in which you want to install PHP Censor, for example: /var/www:
cd /var/www
  • Create project by Composer:
composer create-project php-censor/php-censor php-censor.local --keep-vcs

Or download latest archive from GitHub, unzip it and run composer install.

  • Create empty database for application (MySQL/MariaDB or PostgreSQL);

  • Install Beanstalkd Queue (Optional, if you are going to use queue with Worker):

aptitude install beanstalkd # For deb-based
  • Install PHP Censor itself:
cd ./php-censor.local

# Interactive installation
./bin/console php-censor:install

# Non-interactive installation
./bin/console php-censor:install --url='http://php-censor.local' --db-type=pgsql --db-host=localhost --db-name=php-censor --db-user=php-censor --db-password=php-censor --db-port=null --admin-name=admin --admin-password=admin --admin-email='admin@php-censor.local' --queue-use=1 --queue-host=localhost --queue-name=php-censor

# Non-interactive installation with prepared config.yml file
./bin/console php-censor:install --config-from-file=yes --admin-name=admin --admin-password=admin --admin-email='admin@php-censor.local'

Installing via Docker

If you want to install PHP Censor as Docker container, you can use php-censor/docker-php-censor project.

Updating

  • Go to your PHP Censor directory (to /var/www/php-censor.local for example):

    cd /var/www/php-censor.local
    
  • Pull the latest code from repository by Git (If you want latest master branch):

    git checkout master
    git pull -r
    

    Or pull latest version:

    git fetch
    git checkout <version>
    
  • Update the Composer dependencies: composer install

  • Update the database scheme:

    ./bin/console php-censor-migrations:migrate
    
  • Restart Supervisord workers (If you use workers and Supervisord):

    sudo supervisorctl status
    sudo supervisorctl restart <worker:worker_00>
    ...
    sudo supervisorctl restart <worker:worker_nn>
    

    Or restart Systemd workers (If you use workers and Systemd):

    sudo systemctl restart <worker@1.service>
    ...
    sudo systemctl restart <worker@n.service>
    

Configuring project

There are several ways to set up the project:

  • Add project without any project config (Runs "zero-config" plugins, including: Composer, TechnicalDept, PHPLoc, PHPCpd, PHPCodeSniffer, PHPMessDetect, PHPDocblockChecker, PHPParallelLint, PHPUnit and Codeception);

  • Similar to Travis CI, to support PHP Censor in your project, you simply need to add a .php-censor.yml (phpci.yml/.phpci.yml for backward compatibility with PHPCI) file to the root of your repository;

  • Add project config in PHP Censor project page (And it will cancel file config from project repository);

The project config should look something like this:

setup:
  composer:
    action: "install"
test:
  php_unit:
    config: "phpunit.xml"
  php_mess_detector:
    allow_failures: true
  php_code_sniffer:
    standard: "PSR2"
  php_cpd:
    allow_failures: true
complete:
  email:
    default_mailto_address: admin@php-censor.local

More details about configuring project.

Migrations

Run to apply latest migrations:

cd /path/to/php-censor
./bin/console php-censor-migrations:migrate

Run to create new migration:

cd /path/to/php-censor
./bin/console php-censor-migrations:create NewMigrationName

Tests

cd /path/to/php-censor

./vendor/bin/phpunit --configuration ./phpunit.xml --coverage-html ./tests/runtime/coverage -vvv --colors=always

For Phar plugin tests set 'phar.readonly' setting to Off (0) in php.ini config. Otherwise tests will be skipped.

For database B8Framework tests create empty 'b8_test' database on 'localhost' with user/password: root/<empty> for MySQL and with user/password: postgres/<empty> for PostgreSQL (You can change default test user, password and database name in phpunit.xml config constants). If connection failed tests will be skipped.

Documentation

Full PHP Censor documentation.

License

PHP Censor is open source software licensed under the BSD-2-Clause license.