Compare commits
7 commits
master
...
feature-do
| Author | SHA1 | Date | |
|---|---|---|---|
|
ac678c53c2 | ||
|
|
dc87616e12 | ||
|
|
714b5ebf3a | ||
|
|
4ad8ccb1f0 | ||
|
|
ce3e1dc712 | ||
|
|
216917ef7e | ||
|
|
656f7f15b2 |
|
|
@ -163,7 +163,7 @@ to [@vinpel](https://github.com/vinpel). Pull request [#141](https://github.com/
|
|||
- Filtration for errors by severity and plugin. Issue [#85](https://github.com/php-censor/php-censor/issues/85).
|
||||
- Links to errors from summary block (Information tab). Issue [#85](https://github.com/php-censor/php-censor/issues/85).
|
||||
- New dashboard widget with only failed projects (See
|
||||
[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring.md#dashboard-widgets)).
|
||||
[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring-application.md#dashboard-widgets)).
|
||||
Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#131](https://github.com/php-censor/php-censor/pull/131).
|
||||
- Ability to call Git webhook by project name instead id. Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request
|
||||
[#132](https://github.com/php-censor/php-censor/pull/132).
|
||||
|
|
@ -171,7 +171,7 @@ Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#131](https://gith
|
|||
### Changed
|
||||
|
||||
- Dashboard on the index page, now dashboard more flexible and include separated widgets (See
|
||||
[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring.md#dashboard-widgets)).
|
||||
[documentation](https://github.com/php-censor/php-censor/blob/master/docs/en/configuring-application.md#dashboard-widgets)).
|
||||
Thanks to [@ss-gxp](https://github.com/ss-gxp). Pull request [#131](https://github.com/php-censor/php-censor/pull/131).
|
||||
|
||||
### Fixed
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ directory;
|
|||
* Run tests for PHPUnit, Atoum, Behat, Codeception and PHPSpec;
|
||||
|
||||
* Check code via Lint, PHPParallelLint, Pdepend, PHPCodeSniffer, PHPCpd, PHPCsFixer, PHPDocblockChecker, PHPLoc,
|
||||
PHPMessDetect, PHPTalLint and TechnicalDept;
|
||||
PHPMessDetector, PHPTalLint and TechnicalDept;
|
||||
|
||||
* 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;
|
||||
|
|
@ -172,7 +172,7 @@ If you want to install PHP Censor as Docker container, you can use
|
|||
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);
|
||||
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` (`phpci.yml`/`.phpci.yml` for backward compatibility with PHPCI) file to the root of your repository;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
PHP Censor documentation
|
||||
PHP Censor Documentation
|
||||
========================
|
||||
|
||||
Getting Started
|
||||
|
|
@ -10,7 +10,7 @@ Getting Started
|
|||
* [Run builds using cronjob](workers/cron.md)
|
||||
* [Adding PHP Censor Support to Your Projects](configuring_project.md)
|
||||
* Updating PHP Censor (See [README](../../README.md))
|
||||
* [Configuring PHP Censor](configuring.md)
|
||||
* [Configuring PHP Censor](configuring-application.md)
|
||||
|
||||
Using PHP Censor
|
||||
----------------
|
||||
|
|
@ -24,14 +24,14 @@ Using PHP Censor
|
|||
* Mercurial/Hg
|
||||
* Bitbucket (Hg)
|
||||
* Subversion/Svn
|
||||
* [Injecting variables into messages](interpolation.md)
|
||||
* [Project Status Images and Status Page](status.md)
|
||||
* [Build environments](environments.md)
|
||||
* [Injecting Variables into Messages](interpolation.md)
|
||||
* [Project Public Status Image and Page](status.md)
|
||||
* [Project Environments](environments.md)
|
||||
|
||||
Plugins
|
||||
-------
|
||||
|
||||
### Internal plugins
|
||||
### Internal Plugins
|
||||
|
||||
#### Dependencies
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ Plugins
|
|||
* [PHP Unit](plugins/php_unit.md) - `php_unit`
|
||||
* [PHP Spec](plugins/php_spec.md) - `php_spec`
|
||||
|
||||
#### Code style
|
||||
#### Code Style
|
||||
|
||||
* [Lint](plugins/lint.md) - `lint`
|
||||
* [PDepend](plugins/pdepend.md) - `pdepend`
|
||||
|
|
@ -59,6 +59,7 @@ Plugins
|
|||
* [PHP Mess Detector](plugins/php_mess_detector.md) - `php_mess_detector`
|
||||
* [PHP Parallel Lint](plugins/php_parallel_lint.md) - `php_parallel_lint`
|
||||
* PHP Tal Lint - `php_tal_lint`
|
||||
* Phan - `phan`
|
||||
* [Technical Debt](plugins/technical_debt.md) - `technical_debt`
|
||||
|
||||
#### Databases
|
||||
|
|
@ -97,9 +98,10 @@ Plugins
|
|||
* [Shell](plugins/shell.md) - `shell`
|
||||
* Wipe - `wipe`
|
||||
|
||||
### Third-party plugins
|
||||
### Third-party Plugins
|
||||
|
||||
* [Telegram](https://github.com/php-censor/php-censor-telegram-plugin) - Telegram plugin by
|
||||
[@LEXASOFT](https://github.com/LEXASOFT)
|
||||
|
||||
* [Deployer](https://github.com/php-censor/php-censor-deployer-plugin) - Plugin for [Deployer](http://deployer.org) by
|
||||
[@ketchoop](https://github.com/ketchoop)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Environments
|
||||
============
|
||||
Project Environments
|
||||
====================
|
||||
|
||||
A environment can include several branches - base branch (default project branch) and optional additional branches
|
||||
(which merge into base).
|
||||
|
|
@ -11,6 +11,7 @@ When you build a environment, additional branches merged into base branch.
|
|||
|
||||
For example, it can be useful when you delay merging into master or test some branches at once. Or deploy.
|
||||
|
||||
|
||||
Config example and explanation
|
||||
------------------------------
|
||||
Configuration is specified on project edit page.
|
||||
|
|
@ -56,9 +57,12 @@ Webhooks to include branches in the environment
|
|||
|
||||
Prepare project in GOGS web-admin:
|
||||
|
||||
* Create webhook
|
||||
* Set "Payload URL" to php-censor webhook URL `http://domain.tld/webhook/gogs/project`
|
||||
* Enable triggering "Pull request"
|
||||
* Create labels for your environments in the format: "env:environment-name", for example "env:test"
|
||||
* Create webhook.
|
||||
|
||||
After creating the pull request, to include the branch in the environment, add the appropriate labels.
|
||||
* Set "Payload URL" to php-censor webhook URL like: `http://php-censor.local/webhook/gogs/<project_id>`.
|
||||
|
||||
* Enable triggering "Pull request".
|
||||
|
||||
* Create labels for your environments in the format: `env:<environment-name>` (For example `env:test`).
|
||||
|
||||
* After creating the pull request, to include the branch in the environment, add the appropriate labels.
|
||||
|
|
|
|||
|
|
@ -4,19 +4,36 @@ Injecting variables into messages
|
|||
Most strings used in the build configuration can have variables related to the build inserted into them with the
|
||||
following syntax:
|
||||
|
||||
"My important message is about %SOMETHING%"
|
||||
```
|
||||
"My important message is about %VARIABLE%"
|
||||
```
|
||||
|
||||
Where something can be one of the following:
|
||||
Where `VARIABLE` can be one of the following:
|
||||
|
||||
* **COMMIT** - The commit hash
|
||||
* **SHORT_COMMIT** - The shortened version of the commit hash
|
||||
* **COMMIT_EMAIL** - The email address of the committer
|
||||
* **COMMIT_MESSAGE** - The message written by the committer
|
||||
* **COMMIT_URI** - The URL to the commit
|
||||
* **BRANCH** - The name of the branch
|
||||
* **BRANCH_URI** - The URL to the branch
|
||||
* **PROJECT** - The ID of the project
|
||||
* **BUILD** - The build number
|
||||
* **PROJECT_TITLE** - The name of the project
|
||||
* **BUILD_PATH** - The path to the build
|
||||
* **BUILD_URI** - The URL to the build in PHP Censor
|
||||
* **COMMIT** - The commit hash.
|
||||
|
||||
* **SHORT_COMMIT** - The shortened version of the commit hash.
|
||||
|
||||
* **COMMIT_EMAIL** - The Email address of the committer.
|
||||
|
||||
* **COMMIT_MESSAGE** - The message written by the committer.
|
||||
|
||||
* **COMMIT_URI** - The URL to the commit.
|
||||
|
||||
* **BRANCH** - The name of the branch.
|
||||
|
||||
* **BRANCH_URI** - The URL to the branch.
|
||||
|
||||
* **ENVIRONMENT** - Build environment (See [environments](environments.md)).
|
||||
|
||||
* **PROJECT** - The ID of the project.
|
||||
|
||||
* **BUILD** - The build number.
|
||||
|
||||
* **PROJECT_TITLE** - The name of the project.
|
||||
|
||||
* **PROJECT_URL** - The URL to the project in PHP Censor.
|
||||
|
||||
* **BUILD_PATH** - The path to the build.
|
||||
|
||||
* **BUILD_URI** - The URL to the build in PHP Censor.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Configuration
|
|||
* **template** - The template to use, options are short and long. Default is short on success and long otherwise.
|
||||
|
||||
**Note:** _This plugin will only work if you configured email settings during installation or configured them later in
|
||||
[`config.yml`](../configuring.md)._
|
||||
[`config.yml`](../configuring-application.md)._
|
||||
### Examples
|
||||
|
||||
See [Adding PHP Censor Support to Your Projects](../configuring_project.md) for more information about how to configure plugins.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
Project Status Images and Status Page
|
||||
=====================================
|
||||
Project Public Status Image and Page
|
||||
====================================
|
||||
|
||||
Status Image
|
||||
Status image
|
||||
------------
|
||||
|
||||
Most Continuous Integration systems provide a simple image URL that you can use to display your project status on other
|
||||
|
|
@ -27,7 +27,7 @@ Example:
|
|||
|
||||
|
||||
|
||||
Status Page
|
||||
Status page
|
||||
-----------
|
||||
|
||||
PHP Censor also provides a public project status page, that is accessible for everyone.
|
||||
|
|
|
|||
107
docs/ru/README.md
Normal file
107
docs/ru/README.md
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
Документация PHP Censor
|
||||
=======================
|
||||
|
||||
Для начала
|
||||
----------
|
||||
|
||||
* Установка PHP Censor (Смотри [README](../../README.md))
|
||||
* [Настройка веб-интерфейса](virtual_host.md)
|
||||
* [Запуск сборок с помощью демона (Worker-а)](workers/worker.md)
|
||||
* [Запуск сборок с помощью переодической задачи (Cronjob)](workers/cron.md)
|
||||
* [Настройка проекта для сборки в PHP Censor](configuring_project.md)
|
||||
* Обновление PHP Censor (Смотри [README](../../README.md))
|
||||
* [Настройка PHP Censor](configuring-application.md)
|
||||
|
||||
Использование
|
||||
-------------
|
||||
|
||||
* Автоматическая сборка при пуше коммитов в репозиторий для:
|
||||
* [Git](sources/git.md)
|
||||
* [Github (Git)](sources/github.md)
|
||||
* [Bitbucket (Git)](sources/bitbucket.md)
|
||||
* [GitLab (Git)](sources/gitlab.md)
|
||||
* Gogs (Git)
|
||||
* Mercurial/Hg
|
||||
* Bitbucket (Hg)
|
||||
* Subversion/Svn
|
||||
* [Использование переменных в конфигурации проекта](interpolation.md)
|
||||
* [Бейдж (изображение) со статусом проекта и публичная страница статуса проекта](status.md)
|
||||
* [Использование окружений для проекта](environments.md)
|
||||
|
||||
Плагины
|
||||
-------
|
||||
|
||||
### Плагины, включенные в поставку
|
||||
|
||||
#### Зависимости
|
||||
|
||||
* [Composer](plugins/composer.md) - Плагин для работы с зависимостями при помощи Composer-а (`composer`).
|
||||
* [Security Checker](plugins/security_checker.md) - Плагин для проверки наличия незакрытых уязвимостей в зависимостях
|
||||
проекта с помощью SensioLabs Security Checker (`security_checker`).
|
||||
|
||||
#### Тесты
|
||||
|
||||
* [Atoum](plugins/atoum.md) - `atoum`
|
||||
* [Behat](plugins/behat.md) - `behat`
|
||||
* [Codeception](plugins/codeception.md) - `codeception`
|
||||
* [PHP Unit](plugins/php_unit.md) - `php_unit`
|
||||
* [PHP Spec](plugins/php_spec.md) - `php_spec`
|
||||
|
||||
#### Стиль кода
|
||||
|
||||
* [Lint](plugins/lint.md) - `lint`
|
||||
* [PDepend](plugins/pdepend.md) - `pdepend`
|
||||
* [PHP Code Sniffer](plugins/php_code_sniffer.md) - `php_code_sniffer`
|
||||
* [PHP Copy/Paste Detector](plugins/php_cpd.md) - `php_cpd`
|
||||
* [PHP Coding Standards Fixer](plugins/php_cs_fixes.md) - `php_cs_fixer`
|
||||
* [PHP Docblock Checker](plugins/php_docblock_checker.md) - `php_docblock_checker`
|
||||
* [PHP Loc](plugins/php_loc.md) - `php_loc`
|
||||
* [PHP Mess Detector](plugins/php_mess_detector.md) - `php_mess_detector`
|
||||
* [PHP Parallel Lint](plugins/php_parallel_lint.md) - `php_parallel_lint`
|
||||
* PHP Tal Lint - `php_tal_lint`
|
||||
* Phan - `phan`
|
||||
* [Technical Debt](plugins/technical_debt.md) - `technical_debt`
|
||||
|
||||
#### Базы данных
|
||||
|
||||
* [MySQL](plugins/mysql.md) - `mysql`
|
||||
* [PostgreSQL](plugins/pgsql.md) - `pgsql`
|
||||
* [SQLite](plugins/sqlite.md) - `sqlite`
|
||||
|
||||
#### Деплой
|
||||
|
||||
* [Mage](plugins/mage.md) - `mage`
|
||||
* [Mage v3](plugins/mage3.md) - `mage3`
|
||||
* [Phing](plugins/phing.md) - `phing`
|
||||
* [Deployer](plugins/deployer.md) - `deployer`
|
||||
|
||||
#### Оповещение
|
||||
|
||||
* [Campfire](plugins/campfire.md) - `campfire`
|
||||
* [Email](plugins/email.md) - `email`
|
||||
* FlowDock - `flowdock_notify`
|
||||
* [HipChat](plugins/hipchat_notify.md) - `hipchat_notify`
|
||||
* [IRC](plugins/irc.md) - `irc`
|
||||
* [Slack](plugins/slack_notify.md) - `slack_notify`
|
||||
* [XMPP](plugins/xmpp.md) - `xmpp`
|
||||
|
||||
#### Другое
|
||||
|
||||
* [Clean Build](plugins/clean_build.md) - `clean_build`
|
||||
* [Copy Build](plugins/copy_build.md) - `copy_build`
|
||||
* [Env](plugins/env.md) - `env`
|
||||
* Git - `git`
|
||||
* [Grunt](plugins/grunt.md) - `grunt`
|
||||
* Gulp - `gulp`
|
||||
* [Package Build](plugins/package_build.md) - `package_build`
|
||||
* [Phar](plugins/phar.md) - `phar`
|
||||
* [Shell](plugins/shell.md) - `shell`
|
||||
* Wipe - `wipe`
|
||||
|
||||
### Сторонние плагины, не включенные в поставку
|
||||
|
||||
* [Telegram](https://github.com/php-censor/php-censor-telegram-plugin) - Плагин для оповещения о результатах сборки
|
||||
проекта в Telegram (Автор: [@LEXASOFT](https://github.com/LEXASOFT)).
|
||||
|
||||
* [Deployer](https://github.com/php-censor/php-censor-deployer-plugin) - Плагин для деплоя приложения с помощью
|
||||
библиотеки [Deployer](http://deployer.org) (Автор: [@ketchoop](https://github.com/ketchoop)).
|
||||
112
docs/ru/configuring-application.md
Normal file
112
docs/ru/configuring-application.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
Настройка PHP Censor
|
||||
====================
|
||||
|
||||
Формат конфигурационного файла
|
||||
------------------------------
|
||||
|
||||
Ниже приведен пример конфигурационного файла приложения:
|
||||
|
||||
```yml
|
||||
b8:
|
||||
database:
|
||||
servers:
|
||||
read:
|
||||
- host: localhost
|
||||
port: 3306
|
||||
write:
|
||||
- host: localhost
|
||||
port: 3306
|
||||
type: mysql # Database type: "mysql" or "pgsql"
|
||||
name: php-censor-db
|
||||
username: php-censor-user
|
||||
password: php-censor-password
|
||||
php-censor:
|
||||
language: en
|
||||
per_page: 10
|
||||
url: 'http://php-censor.local'
|
||||
email_settings:
|
||||
from_address: 'PHP Censor <no-reply@php-censor.local>'
|
||||
smtp_address: null
|
||||
smtp_port: null
|
||||
smtp_username: null
|
||||
smtp_password: null
|
||||
smtp_encryption: false
|
||||
queue:
|
||||
use_queue: true
|
||||
host: localhost
|
||||
name: php-censor-queue
|
||||
lifetime: 600
|
||||
log:
|
||||
rotate: true
|
||||
max_files: 10
|
||||
ssh:
|
||||
strength: 4096 # SSH keys strength (default: 2048)
|
||||
comment: admin@php-censor.info # SSH keys comment (default: admin@php-censor)
|
||||
bitbucket:
|
||||
username: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
app_password: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
|
||||
comments:
|
||||
commit: false # This option allow/deny to post comments to Bitbucket commit
|
||||
pull_request: false # This option allow/deny to post comments to Bitbucket Pull Request
|
||||
status:
|
||||
commit: false # This option allow/deny to post status to Bitbucket commit
|
||||
github:
|
||||
token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
|
||||
comments:
|
||||
commit: false # This option allow/deny to post comments to Github commit
|
||||
pull_request: false # This option allow/deny to post comments to Github Pull Request
|
||||
status:
|
||||
commit: false # This option allow/deny to post status to Github commit
|
||||
build:
|
||||
remove_builds: true # This option allow/deny build cleaning
|
||||
writer_buffer_size: 500 # BuildErrorWriter buffer size (count of inserts in one SQL query)
|
||||
security:
|
||||
disable_auth: false # This option allows/deny you to disable authentication for PHP Censor
|
||||
default_user_id: 1 # Default user when authentication disabled
|
||||
auth_providers: # Authentication providers
|
||||
internal:
|
||||
type: internal # Default provider (PHP Censor internal authentication)
|
||||
ldap:
|
||||
type: ldap # Your LDAP provider
|
||||
data:
|
||||
host: 'ldap.php-censor.local'
|
||||
port: 389
|
||||
base_dn: 'dc=php-censor,dc=local'
|
||||
mail_attribute: mail
|
||||
dashboard_widgets:
|
||||
all_projects:
|
||||
side: left
|
||||
last_builds:
|
||||
side: right
|
||||
```
|
||||
|
||||
### Настройки базы данных
|
||||
|
||||
### Общие настройки
|
||||
|
||||
### Почтовые настройки
|
||||
|
||||
### Настройки очереди сборок
|
||||
|
||||
### Настройки логирования
|
||||
|
||||
### Настройки интеграции с BitBucket
|
||||
|
||||
### Настройки интеграции с GitHub
|
||||
|
||||
### Настройки сборки
|
||||
|
||||
### Настройки безопасности
|
||||
|
||||
### Настройки панели управления
|
||||
|
||||
* `all_projects` - all projects build status
|
||||
* `last_builds` - last builds
|
||||
* `build_errors` - not successful builds
|
||||
|
||||
Each widget can be located in the left or right column, use the `side` option for this:
|
||||
|
||||
```yml
|
||||
all_projects:
|
||||
side: left
|
||||
```
|
||||
320
docs/ru/configuring-project.md
Normal file
320
docs/ru/configuring-project.md
Normal file
|
|
@ -0,0 +1,320 @@
|
|||
Настройка сборки проекта в PHP Censor
|
||||
=====================================
|
||||
|
||||
Способы конфигурации
|
||||
--------------------
|
||||
|
||||
Для конфигурации сборки проектов *PHP Censor* использует декларативное описание в формате YAML (Подобно
|
||||
[Travis CI](https://travis-ci.org)).
|
||||
|
||||
Есть несколько способов настроить сборку проекта в *PHP Censor*:
|
||||
|
||||
1. Добавить проект вообще без какой-либо конфигурации (Самый простой способ).
|
||||
|
||||
В этом случае сборка будет запущена со стандартной конфигурацией, которая включает в себя плагины для установки
|
||||
зависимостей ([Composer](plugins/composer.md)), статического анализа кода (
|
||||
[TechnicalDept](plugins/technical_dept.md), [PHPLoc](plugins/php_loc.md), [PHPCpd](plugins/php_cpd.md),
|
||||
[PHPCodeSniffer](plugins/php_code_sniffer.md), [PHPMessDetector](plugins/php_mess_detector.md),
|
||||
[PHPDocblockChecker](plugins/php_docblock_checker.md), [PHPParallelLint](plugins/php_parallel_lint.md)), а также
|
||||
плагины для запуска тестов ([PHPUnit](plugins/php_unit.md), [Codeception](plugins/codeception.md)).
|
||||
|
||||
**Плагины для запуска тестов запустятся, если смогут найти конфигурации и тесты по стандартным путям**.
|
||||
|
||||
При сборке без конфигурации будет сгенерирован примерно такой конфигурационный файл:
|
||||
|
||||
```yml
|
||||
build_settings:
|
||||
ignore:
|
||||
- "vendor"
|
||||
setup:
|
||||
composer:
|
||||
action: "install"
|
||||
test:
|
||||
technical_debt:
|
||||
allowed_errors: -1
|
||||
php_code_sniffer:
|
||||
allowed_warnings: -1
|
||||
allowed_errors: -1
|
||||
php_mess_detector:
|
||||
allowed_warnings: -1
|
||||
php_docblock_checker:
|
||||
allowed_warnings: -1
|
||||
security_checker:
|
||||
allowed_warnings: -1
|
||||
php_parallel_lint:
|
||||
php_loc:
|
||||
php_cpd:
|
||||
codeception:
|
||||
php_unit:
|
||||
```
|
||||
|
||||
2. Добавить конфигурационный файл `.php-censor.yml` (поддерживается так же названия `phpci.yml`/`.phpci.yml` для
|
||||
обеспечения обратной совместимости c [PHPCI](https://www.phptesting.org)) в корень репозитория проекта.
|
||||
|
||||
3. Добавить конфигурационный файл в веб-интерфейсе при добавлении проекта в *PHP Censor*.
|
||||
|
||||
По-умолчанию, конфигурация проекта из веб-интерфейса будет полностью заменять конфигурацию из репозитория (Файл
|
||||
`.php-censor.yml`), но если в настройках проекта убрать отметку с чекбокса "Заменить конфигурацию из файла в
|
||||
проекте конфигурацией из базы данных?..." то конфигурации будут объеденены (С приоритетом в пользу конфигурации из
|
||||
веб-интерфейса).
|
||||
|
||||
Задание конфигурации в веб-интерфейсе и объединение с конфигурацией из репозитория может понадобиться для
|
||||
скрытия секретных данных (паролей, ключей) в случае использования публичного репозитория. Большую публичную часть
|
||||
конфигурации можно держать в виде файла в репозитории, а пароли и ключи добавить в веб-интерфейсе.
|
||||
|
||||
**Наивысший приоритет имеет конфигурация заданная через веб-интерфейс, затем конфигурация, которая расположена в корне
|
||||
проекта.**
|
||||
|
||||
|
||||
Формат конфигурационного файла
|
||||
------------------------------
|
||||
|
||||
Ниже приведен пример конфигурационного файла проекта:
|
||||
|
||||
```yml
|
||||
build_settings:
|
||||
clone_depth: 1
|
||||
ignore:
|
||||
- "vendor"
|
||||
- "tests"
|
||||
mysql:
|
||||
host: "localhost"
|
||||
user: "root"
|
||||
pass: ""
|
||||
|
||||
setup:
|
||||
mysql:
|
||||
- "DROP DATABASE IF EXISTS test;"
|
||||
- "CREATE DATABASE test;"
|
||||
- "GRANT ALL PRIVILEGES ON test.* TO test@'localhost' IDENTIFIED BY 'test';"
|
||||
composer:
|
||||
action: "install"
|
||||
|
||||
test:
|
||||
php_unit:
|
||||
config:
|
||||
- "PHPUnit-all.xml"
|
||||
- "PHPUnit-ubuntu-fix.xml"
|
||||
directory:
|
||||
- "tests/"
|
||||
run_from: "phpunit/"
|
||||
coverage: "tests/logs/coverage"
|
||||
php_mess_detector:
|
||||
allow_failures: true
|
||||
php_code_sniffer:
|
||||
standard: "PSR2"
|
||||
php_cpd:
|
||||
allow_failures: true
|
||||
grunt:
|
||||
task: "build"
|
||||
|
||||
deploy:
|
||||
deployer:
|
||||
webhook_url: "http://deployer.local/deploy/QZaF1bMIUqbMFTmKDmgytUuykRN0cjCgW9SooTnwkIGETAYhDTTYoR8C431t"
|
||||
reason: "PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%"
|
||||
update_only: true
|
||||
|
||||
complete:
|
||||
mysql:
|
||||
host: "localhost"
|
||||
user: "root"
|
||||
pass: ""
|
||||
- "DROP DATABASE IF EXISTS test;"
|
||||
|
||||
branch-dev:
|
||||
run-option: replace
|
||||
test:
|
||||
grunt:
|
||||
task: "build-dev"
|
||||
```
|
||||
|
||||
|
||||
### Общие настройки
|
||||
|
||||
Секция `build_settings` содержит общие настройки сборки:
|
||||
|
||||
* Опция `verbose` позволяет отключить подробный вывод плагинов (По-умолчанию `verbose: true`, то есть выводится
|
||||
все возможные логи).
|
||||
|
||||
* Опция `clone_depth` позволяет клонировать репозиторий с усеченной историей (До количества коммитов, указанных в
|
||||
`clone_depth`). Доступна для Git (GitHub, GitLab, BitBucket, Gogs) и Svn (Subversion) проектов. Технически, при
|
||||
клонировании репозитория добавляется опция `--depth=N`.
|
||||
|
||||
**ВНИМАНИЕ!:** Опцию `clone_depth` можно задавать только в веб-интерфейсе конфигурации проекта (с заменой
|
||||
конфигурации из репозитория или дополнением), т.к. конфигурация должна быть доступна до начала клонирования
|
||||
проекта (В случае веб-интерфейса, она берется из базы данных).
|
||||
|
||||
* Опция `ignore` задает массив путей, которые будут игнорироваться при анализе кода плагинами. Например:
|
||||
|
||||
```yml
|
||||
build_settings:
|
||||
ignore:
|
||||
- vendor
|
||||
- tests
|
||||
```
|
||||
|
||||
* Опция `prefer_symlink` позволяет использовать ссылку (symlink) в качестве источника для сборки. Доступна только для
|
||||
проектов из локальной директории (LocalBuild).
|
||||
|
||||
* Существуют опции для глобальной конфигурации некоторых плагинов ([Campfire](plugins/campfire.md),
|
||||
[Irc](plugins/irc.md), [Mysql](plugins/mysql.md), [Pgsql](plugins/pgsql.md) и [Sqlite](plugins/sqlite.md)),
|
||||
информацию он них можно посмотреть в [документации к соответсвующим плагинам](README.md).
|
||||
|
||||
* Существуют так же опции для конфигурирования дополнительных параметров командной строки для Svn (Subversion).
|
||||
Например:
|
||||
|
||||
```yml
|
||||
build_settings:
|
||||
svn:
|
||||
username: "username"
|
||||
password: "password"
|
||||
```
|
||||
|
||||
**ВНИМАНИЕ!:** Секцию `svn` можно задавать только в веб-интерфейсе конфигурации проекта (с заменой конфигурации
|
||||
из репозитория или дополнением), т.к. конфигурация должна быть доступна до начала клонирования проекта (В случае
|
||||
веб-интерфейса, она берется из базы данных).
|
||||
|
||||
|
||||
### Этапы сборки
|
||||
|
||||
Сборка проекта проходит несколько этапов. Во время каждого этапа можно выполнять некоторые плагины:
|
||||
|
||||
* `setup` - **Этап настройки сборки** (создание тестовой базы данных, установка зависимостей и т.д.).
|
||||
|
||||
* `test` - **Этап тестирования**. Вызывается после `setup`, если он был успешным. В этапе тестирования запускаются
|
||||
все основные тестовые плагины и статические анализаторы кода.
|
||||
|
||||
**Завершение отдельного плагина с ошибками не всегда обозначает провал всего этапа**, т.к. можно
|
||||
использовать опцию `allow_failures` доступную всем плагинам, которая позволяет игнорировать ошибки конкретного
|
||||
плагина в статусе сборки (Пример: `allow_failures: true`).
|
||||
|
||||
**Так же можно ограничить количество допустимых ошибок и предупреждений, которое приводит к провалу конкретного
|
||||
плагина** с помощью опций `allowed_errors` и `allowed_warnings` (Например: `allowed_warnings: 2`). Значение `-1`
|
||||
будет означать неограниченное кол-во. **Эти опции доступны не для всех плагинов**, подробности можно посмотреть в
|
||||
[документации к конкретному плагину](README.md).
|
||||
|
||||
Так же существует опция `priority_path` доступная всем плагинам. **Она позволяет поменять порядок поиска
|
||||
исполняемого файла плагина**. Возможные значения опции:
|
||||
|
||||
* `local` - В первую очередь искать в директории `vendor/bin` самой сборки, затем в `global`, затем в `system`;
|
||||
|
||||
* `global` - В первую очередь искать в директории `vendor/bin` *PHP Censor*, затем в `local`, затем в `system`;
|
||||
|
||||
* `sysmem` - В первую очередь искать среди системных утилит (В директориях `/bin`, `/usr/bin` и т.д., используется
|
||||
`which`. ), затем в `local`, затем в `global`;
|
||||
|
||||
**Порядок поиска исполняемого файла по умолчанию**: `local` -> `global` -> `system`.
|
||||
|
||||
* `deploy` - **Этап деплоя проекта**. Вызывается после `test`, если он был успешным. В этом этапе должны
|
||||
вызываться плагины для деплоя приложения ([Shell](plugins/shell.md), [Deployer](plugins/deployer.md),
|
||||
[Mage](plugins/mage.md) и т.д.). В целом этот этап работает аналогично `test`.
|
||||
|
||||
* `complete` - **Этап завершения сборки**. Вызывается **всегда** после `deploy` (или `test`, если `deploy`
|
||||
отсутствует), вне зависимости от того, была ли сборка успешной или провалилась. В этой фазе можно отсылать нотификации
|
||||
или очищать тестовую базу данных и т.д.
|
||||
|
||||
* `success` - **Этап успешной сборки**. Вызывается лишь тогда, когда сборка завершилась успешно.
|
||||
|
||||
* `failure` - **Этап проваленной сборки**. Вызывается лишь тогда, когда сборка провалилась.
|
||||
|
||||
* `fixed` - **Этап восстановления сборки**. Вызывается лишь тогда, когда сборка завершилась успешно после проваленной
|
||||
предыдущей сборки.
|
||||
|
||||
* `broken` - **Этап поломки сборки**. Вызывается лишь тогда, когда сборка провалилась после успешной предыдущей сборки.
|
||||
|
||||
**Некоторые плагины имеют ограничения на этапы, в которых они могут быть запущены**. Например плагины
|
||||
[TechnicalDept](plugins/technical_dept.md), [PHPLoc](plugins/php_loc.md), [PHPCpd](plugins/php_cpd.md),
|
||||
[PHPCodeSniffer](plugins/php_code_sniffer.md), [PHPMessDetector](plugins/php_mess_detector.md),
|
||||
[PHPDocblockChecker](plugins/php_docblock_checker.md), [PHPParallelLint](plugins/php_parallel_lint.md),
|
||||
[Codeception](plugins/codeception.md), [PhpUnit](plugins/php_unit.md) могут быть запущены только на этапе `test`,
|
||||
а плагин [Composer](plugins/composer.md), - только на этапе `setup`.
|
||||
|
||||
|
||||
### Переопределение конфигурации для конкретных веток
|
||||
|
||||
Директива `branch-<branch-name>` (Например: `branch-feature-1` для ветки `feature-1`) **позволяет переопределять или
|
||||
дополнять основную конфигурацию сборки для отдельных веток**.
|
||||
|
||||
Существует так же директива `branch-regex:<branch-name-regex>` **для сопоставления ветки по регулярному выражению**
|
||||
для тех же целей (Например: `branch-regex:^feature\-\d$` для веток: `feature-1`, `feature-2` и т.д.).
|
||||
|
||||
**Если используется несколько директив `branch-regex:`/`branch-`, то будет использована первая, которая
|
||||
совпадет с названием ветки сборки.**
|
||||
|
||||
Обязательный параметр `run-option` позволяет указать, переопределять или дополнять конфигурацию и может принимать
|
||||
следующие значения:
|
||||
|
||||
* `replace` - Позволяет перекрывать некоторые настройки для отдельных веток.
|
||||
|
||||
* `before` - Позволяет дополнить конфигурацию для конкретной ветки настройками, которые будут запущены до основной
|
||||
конфигурации.
|
||||
|
||||
* `after` - Позволяет дополнить конфигурацию для конкретной ветки настройками, которые будут запущены после основной
|
||||
конфигурации.
|
||||
|
||||
Пример конфигурации:
|
||||
|
||||
```yml
|
||||
test
|
||||
|
||||
...
|
||||
|
||||
branch-regex:^feature\-\d$:
|
||||
run-option: replace
|
||||
test:
|
||||
grunt:
|
||||
task: "build-feature"
|
||||
branch-dev:
|
||||
run-option: replace
|
||||
test:
|
||||
grunt:
|
||||
task: "build-dev"
|
||||
branch-codeception:
|
||||
run-option: after
|
||||
test:
|
||||
codeception:
|
||||
```
|
||||
|
||||
### Некоторые полезные особенности формата YAML
|
||||
|
||||
Некоторые особенности формата YAML могут быть очень полезными, например: комментарии, многострочные выражения и
|
||||
подстановки с помощью якорей (`&`) и алиасов (`*`).
|
||||
|
||||
Пример комментария:
|
||||
|
||||
```yml
|
||||
# YAML-комментарий
|
||||
setup:
|
||||
shell: echo 1
|
||||
```
|
||||
|
||||
Пример организации многострочного выражения c сохранением перевода строки:
|
||||
|
||||
```yml
|
||||
setup:
|
||||
shell: |
|
||||
echo 1
|
||||
echo 2
|
||||
```
|
||||
|
||||
Пример организации многострочного выражения без сохранения перевода строки:
|
||||
|
||||
```yml
|
||||
setup:
|
||||
shell: >
|
||||
echo 1
|
||||
echo 2
|
||||
```
|
||||
|
||||
Пример подстановки:
|
||||
|
||||
```yml
|
||||
setup:
|
||||
# Якорь (метка)
|
||||
shell: &anchor1 echo 1
|
||||
test:
|
||||
# Алиас (подстановка по имени якоря)
|
||||
shell: *anchor1
|
||||
```
|
||||
|
||||
Больше информации о YAML формате можно узнать на [официальном сайте](http://www.yaml.org/spec/1.2/spec.html).
|
||||
81
docs/ru/environments.md
Normal file
81
docs/ru/environments.md
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
Использование окружений для проекта
|
||||
===================================
|
||||
|
||||
Окружение может включать несколько веток: основная ветка (ветка проекта по-умолчанию) и опционально дополнительные
|
||||
ветки, которые будут влиты в основную ветку при клонировании репозитория (Дополнительных веток может быть больше
|
||||
одной, все они будут влиты в основную по очереди).
|
||||
|
||||
Когда код пушится в какую-либо ветку, создаются сборки со всеми окружениями, включающими данную ветку (Основная ветка
|
||||
неявно связана со всеми окружениями).
|
||||
|
||||
Это может быть полезно например, когда нужно отложить вливание ветки в `master`-ветку в репозитории или
|
||||
необходимо протестировать несколько веток вместе. Так же это может пригодится при деплое.
|
||||
|
||||
|
||||
Примеры конфигурации и пояснения
|
||||
--------------------------------
|
||||
|
||||
Конфигурирование окружений производится через веб-интерфейс на странице создания/редактирования проекта.
|
||||
|
||||
Ниже пример для проекта с 3мя окружениями:
|
||||
|
||||
* Production (`pr`) - Связан с веткой проекта по-умолчанию (Например: `master`. По сути обычная сборка без слияния
|
||||
веток).
|
||||
|
||||
* Release candidate (`rc`) - В основную ветку (`master`) вливается ветка `feature-A`.
|
||||
|
||||
* Test (`test`) - В основную ветку (`master`) вливается ветка `feature-B`
|
||||
|
||||
```yml
|
||||
pr:
|
||||
rc:
|
||||
- feature-A
|
||||
test:
|
||||
- feature-B
|
||||
```
|
||||
|
||||
Если код пушится в ветку `master`, то создается 3 сборки по одной на каждое окружение.
|
||||
|
||||
Если код пушится в ветку `feature-A`, то создается одна сборка с окружением `rc` (То же самое произойдет и для ветки
|
||||
`feature-B`, только сборка будет с окружением `test`).
|
||||
|
||||
Если код пушится в ветку `feature-C`, которая не связаны ни с одним окружением, то создастся одна обычная сборка (Так
|
||||
же как, если бы окружения не были настроены вовсе).
|
||||
|
||||
|
||||
Использование переменной %ENVIRONMENT% в конфигурации проекта
|
||||
-------------------------------------------------------------
|
||||
|
||||
Вы можете получить и использовать текущее окружение с помощью переменной `%ENVIRONMENT%` (Смотри [Использование
|
||||
переменных в конфигурации проекта](interpolation.md)). Например:
|
||||
|
||||
```yml
|
||||
setup:
|
||||
mysql:
|
||||
- "DROP DATABASE IF EXISTS project_name_%ENVIRONMENT%;"
|
||||
- "CREATE DATABASE project_name_%ENVIRONMENT%;"
|
||||
test:
|
||||
...
|
||||
deploy:
|
||||
mage:
|
||||
env: %ENVIRONMENT%
|
||||
```
|
||||
|
||||
|
||||
Добавление веток в окружение с помощью webhook-а
|
||||
------------------------------------------------
|
||||
|
||||
### Gogs
|
||||
|
||||
Необходимо подготовить проект в веб-интерфейсе Gogs:
|
||||
|
||||
* Создать webhook для проекта.
|
||||
|
||||
* Установить в поле "Payload URL" URL-адрес webhook-а для Gogs из PHP Censor (Например:
|
||||
`http://php-censor.local/webhook/gogs/<project_id>`).
|
||||
|
||||
* Включить отправку события "Pull request".
|
||||
|
||||
* Создать метки (labels) для ваших окружений в формате: `env:<environment-name>` (Например: `env:test`).
|
||||
|
||||
* После создания запроса на слияние для добавления ветки в окружение, добавьте необходимые метки.
|
||||
40
docs/ru/interpolation.md
Normal file
40
docs/ru/interpolation.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
Использование переменных в конфигурации проекта
|
||||
===============================================
|
||||
|
||||
Большое количество строковых параметров, используемых при сборке проекта имеют соответствующие переменные. Эти
|
||||
переменные можно использовать в различных сообщениях и параметрах сборки, используя следующий синтаксис:
|
||||
|
||||
```
|
||||
"Важное сообщение о %VARIABLE%"
|
||||
```
|
||||
|
||||
Где `VARIABLE` может принимать следующее название:
|
||||
|
||||
|
||||
* **COMMIT** - Идентификатор коммита сборки (Хэш коммита).
|
||||
|
||||
* **SHORT_COMMIT** - Укороченная версия идентификатор коммита сборки (Укороченный хэш коммита).
|
||||
|
||||
* **COMMIT_EMAIL** - Email-адрес автора коммита.
|
||||
|
||||
* **COMMIT_MESSAGE** - Сообщение коммита.
|
||||
|
||||
* **COMMIT_URI** - URL-адрес коммита.
|
||||
|
||||
* **BRANCH** - Название ветки сборки.
|
||||
|
||||
* **BRANCH_URI** - URL-адрес ветки.
|
||||
|
||||
* **ENVIRONMENT** - Окружение сборки (Смотри [окружения](environments.md)).
|
||||
|
||||
* **PROJECT** - ID проекта в PHP Censor.
|
||||
|
||||
* **BUILD** - ID сборки в PHP Censor.
|
||||
|
||||
* **PROJECT_TITLE** - Название проекта.
|
||||
|
||||
* **PROJECT_URL** - URL-адрес проекта в PHP Censor.
|
||||
|
||||
* **BUILD_PATH** - Путь к директории сборки.
|
||||
|
||||
* **BUILD_URI** - URL-адрес сборки в PHP Censor.
|
||||
14
docs/ru/screenshots.md
Normal file
14
docs/ru/screenshots.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
Скриншоты
|
||||
=========
|
||||
|
||||
[](../screenshots/login.png)
|
||||
|
||||
[](../screenshots/dashboard.png)
|
||||
|
||||
[](../screenshots/project.png)
|
||||
|
||||
[](../screenshots/build-log.png)
|
||||
|
||||
[](../screenshots/build-errors.png)
|
||||
|
||||
[](../screenshots/build-information.png)
|
||||
50
docs/ru/status.md
Normal file
50
docs/ru/status.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
Project Status Image and Status Page
|
||||
====================================
|
||||
|
||||
Status Image
|
||||
------------
|
||||
|
||||
Most Continuous Integration systems provide a simple image URL that you can use to display your project status on other
|
||||
web sites (like Github) - PHP Censor is no different.
|
||||
|
||||
You can find the status image at the following location: `http://{PHP_CENSOR_URL}/build-status/image/{PROJECT ID}`
|
||||
|
||||
So for example, our instance of PHP Censor is at `php-censor.local`, and our PHP Censor project ID is `2`, so the image
|
||||
URL is: `http://php-censor.local/build-status/image/2`.
|
||||
|
||||
You can use additional parameters:
|
||||
|
||||
* style: plastic | flat (default) | flat-squared | social
|
||||
* label: build (default)
|
||||
* logo
|
||||
* logoWidth
|
||||
* link
|
||||
* maxAge
|
||||
|
||||
[See more on shields.io site](http://shields.io)
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
|
||||
Status Page
|
||||
-----------
|
||||
|
||||
PHP Censor also provides a public project status page, that is accessible for everyone.
|
||||
|
||||
You can find the status page at the following location: `http://{PHP_CENSOR_URL}/build-status/view/{PROJECT ID}`
|
||||
|
||||
Example:
|
||||
http://php-censor.local/build-status/view/2
|
||||
|
||||
### Where do I find my project ID?
|
||||
|
||||
Go to your instance of PHP Censor, and open the project you are interested in. The project ID is the number in the last
|
||||
part of the URL in your browser.
|
||||
|
||||
Example:
|
||||
http://php-censor.local/project/view/2 ~> PROJECT ID: `2`
|
||||
|
||||
### Enable/disable status image and page
|
||||
|
||||
You can enable or disable access to the public status image and page in your project's settings.
|
||||
Loading…
Reference in a new issue