https://github.com/php-censor/php-censor
PHP Censor is an open source self-hosted continuous integration server for PHP projects.
https://github.com/php-censor/php-censor
ci continuous-integration database-testing hacktoberfest php php-censor phpcensor phpci self-hosted testing unit-testing
Last synced: 5 days ago
JSON representation
PHP Censor is an open source self-hosted continuous integration server for PHP projects.
- Host: GitHub
- URL: https://github.com/php-censor/php-censor
- Owner: php-censor
- License: bsd-2-clause
- Created: 2017-01-04T14:39:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T05:01:46.000Z (6 months ago)
- Last Synced: 2024-10-17T22:41:14.831Z (6 months ago)
- Topics: ci, continuous-integration, database-testing, hacktoberfest, php, php-censor, phpcensor, phpci, self-hosted, testing, unit-testing
- Language: PHP
- Homepage: http://php-censor.info
- Size: 24.1 MB
- Stars: 678
- Watchers: 28
- Forks: 146
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-sysadmin - PHP Censor - Open source self-hosted continuous integration server for PHP projects. `BSD-2-Clause` `PHP` (Software / Continuous Integration & Continuous Deployment)
- fucking-awesome-sysadmin - PHP Censor - Open source self-hosted continuous integration server for PHP projects. `BSD-2-Clause` `PHP` (Software / Continuous Integration & Continuous Deployment)
- awesome-for-beginners - PHP Censor - for-beginner)_ <br> Open source self-hosted continuous integration server for PHP projects. (PHP)
- awesome-sysadmin - PHP Censor - Open source self-hosted continuous integration server for PHP projects. `BSD-2-Clause` `PHP` (Software / Continuous Integration & Continuous Deployment)
- awesome-sysadmin - PHP Censor - Open source self-hosted continuous integration server for PHP projects. `BSD-2-Clause` `PHP` (Software / Continuous Integration & Continuous Deployment)
- awesome-readme - php-censor/php-censor - Multiple badges, project logo, screenshots, step-by-step installing and upgrading instructions, TOC for easy navigation. (Examples)
- fucking-awesome-for-beginners - PHP Censor - for-beginner)_ <br> Open source self-hosted continuous integration server for PHP projects. (PHP)
- fucking-awesome-readme - php-censor/php-censor - Multiple badges, project logo, feature list, video demo, step-by-step installation and upgrading instructions, TOC for easy navigation. (Examples)
- awesome-readme - php-censor/php-censor - Multiple badges, project logo, feature list, video demo, step-by-step installation and upgrading instructions, TOC for easy navigation. (Examples)
README
[](https://packagist.org/packages/php-censor/php-censor)
[](https://github.com/php-censor/php-censor/actions)
[](http://ci.php-censor.info/build-status/view/2?branch=master)
[](https://codecov.io/gh/php-censor/php-censor)
[](https://packagist.org/packages/php-censor/php-censor)
[](https://packagist.org/packages/php-censor/php-censor)
[](https://packagist.org/packages/php-censor/php-censor)
**PHP Censor** is an open source, self-hosted, continuous integration server for PHP projects
([PHPCI](https://github.com/dancryer/PHPCI) fork). [Official twitter @php_censor](https://twitter.com/php_censor).
PHP Censor versions:
| Version | Latest | Branch | Status | Minimal PHP Version |
|:---------------------:|:--------:|:-------------:|:------------------------------------------------------------------:| :-----------------: |
| `1.0` (Morty Smith) | `1.0.16` | `release-1.0` | Old version (**UNSUPPORTED**) | `>=5.6, <8.0` |
| `1.1` (Birdperson) | `1.1.6` | `release-1.1` | Old version (**UNSUPPORTED**) | `>=5.6, <8.0` |
| `1.2` (Summer Smith) | `1.2.4` | `release-1.2` | Old version (**UNSUPPORTED**) | `>=5.6, <8.0` |
| `1.3` (Jerry Smith) | `1.3.7` | `release-1.3` | Old version (**UNSUPPORTED**) | `>=5.6, <8.0` |
| `2.0` (Rick Sanchez) | `2.0.14` | `release-2.0` | Last stable version ([Upgrade from v1 to v2](docs/UPGRADE_2.0.md)) | `>=7.4` |
| `2.1` (Mr. Meeseeks) | `2.1.6` | `release-2.1` | Current stable version | `>=7.4` |
| `2.2` | WIP | `master` | Feature minor version (WIP) | `>=7.4` |
[](docs/screenshots/dashboard.png)
More [screenshots](docs/en/screenshots.md).
* [System requirements](#system-requirements)
* [Features](#features)
* [Changelog](#changelog)
* [Roadmap](#roadmap)
* [Installing](#installing)
* [Updating](#updating)
* [Configuring project](#configuring-project)
* [Migrations](#migrations)
* [Code style](#code-style)
* [Tests](#tests)
* [Documentation](#documentation)
* [License](#license)
## System requirements
* Unix-like OS (**Windows isn't supported**);
* PHP 7.4+ (with OpenSSL support and enabled functions: `exec()`, `shell_exec()` and `proc_open()`);
* Web-server (Nginx or Apache2);
* Database (MySQL/MariaDB or PostgreSQL);
* Beanstalkd queue;
## Features
* Clone project from [GitHub](docs/en/sources/github.md), [Bitbucket](docs/en/sources/bitbucket.md) (Git/Hg),
[GitLab](docs/en/sources/gitlab.md), [Git](docs/en/sources/git.md), Hg (Mercurial), SVN (Subversion) or from local
directory;
* Set up and tear down database tests for [PostgreSQL](docs/en/plugins/pgsql.md), [MySQL](docs/en/plugins/mysql.md) or
[SQLite](docs/en/plugins/sqlite.md);
* Install [Composer](docs/en/plugins/composer.md) dependencies;
* Run tests for PHPUnit, Atoum, Behat, Codeception and PHPSpec;
* Check code via Lint, PHPParallelLint, Pdepend, PHPCodeSniffer, PHPCpd, PHPCsFixer, PHPDocblockChecker, PHPLoc,
PHPMessDetector, PHPTalLint and TechnicalDebt;
* Run through any combination of the other [supported plugins](docs/en/README.md#plugins), including Campfire,
CleanBuild, CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe;
* Send notifications to Email, XMPP, Slack, IRC, Flowdock and
[Telegram](docs/en/plugins/telegram_notify.md);
* Use your LDAP-server for authentication;
## Changelog
[Versions changelog](CHANGELOG.md).
## Roadmap
See [milestones](https://github.com/php-censor/php-censor/milestones).
## Installing
See [Installing](docs/en/installing.md) section in documentation;
## Updating
See [Updating](docs/en/updating.md) section in documentation;
## Configuring project
There are several ways to set up the project:
* Add project without any project config (Runs "zero-config" plugins, including: Composer, TechnicalDebt, PHPLoc,
PHPCpd, PHPCodeSniffer, PHPMessDetector, PHPDocblockChecker, PHPParallelLint, PHPUnit and Codeception);
* Similar to [Travis CI](https://travis-ci.org), to support PHP Censor in your project, you simply need to add a
`.php-censor.yml` 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:
```yml
setup:
composer:
action: "install"
directory: "."
test:
php_unit:
config: "phpunit.xml"
php_mess_detector:
allow_failures: true
php_code_sniffer:
standard: "PSR2"
php_cpd:
allow_failures: true
complete:
email_notify:
default_mailto_address: [email protected]
```
More details about [configuring project](docs/en/configuring_project.md) in documentation.
## Migrations
Run to apply latest migrations:
```bash
cd /path/to/php-censor
./bin/console php-censor-migrations:migrate
```
Run to create a new migration:
```bash
cd /path/to/php-censor
./bin/console php-censor-migrations:create NewMigrationName
```
## Code style
```bash
cd /path/to/php-censor
./vendor/bin/php-cs-fixer fix --allow-risky=yes
```
## Tests
```bash
cd /path/to/php-censor
./vendor/bin/phpunit --configuration ./phpunit.xml.dist --coverage-html ./tests/runtime/coverage -vvv --colors=always
```
For Phar plugin tests set `phar.readonly` setting to Off (`0`) in `php.ini` config. Otherwise the tests will be skipped.
For database tests create an empty databases on 'localhost' with user/password for MySQL/PostgreSQL and set env
variables from `phpunit.xml.dist` config. For example:
```shell
#!/usr/bin/env bash
psql --username="test" --host="127.0.0.1" --echo-all --command="DROP DATABASE IF EXISTS \"php-censor-test\";"
psql --username="test" --host="127.0.0.1" --echo-all --command="CREATE DATABASE \"php-censor-test\";"
mysql --user="test" --password="test" --host="127.0.0.1" --verbose --execute="CREATE DATABASE IF NOT EXISTS \`php-censor-test\`;"
export SKIP_DB_TESTS=0;\
export POSTGRESQL_DBNAME=php-censor-test;\
export POSTGRESQL_USER=test;\
export POSTGRESQL_PASSWORD=test;\
export MYSQL_DBNAME=php-censor-test;\
export MYSQL_USER=test;\
export MYSQL_PASSWORD=test;\
vendor/bin/phpunit --configuration=phpunit.xml.dist --verbose
```
## Documentation
[Full PHP Censor documentation](docs/en/README.md).
## License
PHP Censor is open source software licensed under the [BSD-2-Clause license](LICENSE).