diff --git a/docs/ru/configuring-project.md b/docs/ru/configuring-project.md index 3b690c41..97623192 100644 --- a/docs/ru/configuring-project.md +++ b/docs/ru/configuring-project.md @@ -53,6 +53,15 @@ 3. Добавить конфигурационный файл в веб-интерфейсе при добавлении проекта в *PHP Censor*. + По-умолчанию, конфигурация проекта из веб-интерфейса будет полностью заменять конфигурацию из репозитория (Файл + `.php-censor.yml`), но если в настройках проекта убрать отметку с чекбокса "Заменить конфигурацию из файла в + проекте конфигурацией из базы данных?..." то конфигурации будут объеденены (С приоритетом в пользу конфигурации из + веб-интерфейса). + + Задание конфигурации в веб-интерфейсе и объединение с конфигурацией из репозитория может понадобиться для + скрытия секретных данных (паролей, ключей) в случае использования публичного репозитория. Большую публичную часть + конфигурации можно держать в виде файла в репозитории, а пароли и ключи добавить в веб-интерфейсе. + **Наивысший приоритет имеет конфигурация заданная через веб-интерфейс, затем конфигурация, которая расположена в корне проекта.** @@ -127,6 +136,14 @@ branch-dev: * Опция `verbose` позволяет отключить подробный вывод плагинов (По-умолчанию `verbose: true`, то есть выводится все возможные логи). +* Опция `clone_depth` позволяет клонировать репозиторий с усеченной историей (До количества коммитов, указанных в +`clone_depth`). Доступна для Git (GitHub, GitLab, BitBucket, Gogs) и Svn (Subversion) проектов. Технически, при +клонировании репозитория добавляется опция `--depth=N`. + + **ВНИМАНИЕ!:** Опцию `clone_depth` можно задавать только в веб-интерфейсе конфигурации проекта (с заменой + конфигурации из репозитория или дополнением), т.к. конфигурация должна быть доступна до начала клонирования + проекта (В случае веб-интерфейса, она берется из базы данных). + * Опция `ignore` задает массив путей, которые будут игнорироваться при анализе кода плагинами. Например: ```yml @@ -136,13 +153,27 @@ branch-dev: - tests ``` -* Опция `prefer_symlink` позволяет использовать ссылку (symlink) в качестве источника для сборки из локальной -директории. +* Опция `prefer_symlink` позволяет использовать ссылку (symlink) в качестве источника для сборки. Доступна только для +проектов из локальной директории (LocalBuild). -* Так же существуют опции для глобальной конфигурации некоторых плагинов ([Campfire](plugins/campfire.md), +* Существуют опции для глобальной конфигурации некоторых плагинов ([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` можно задавать только в веб-интерфейсе конфигурации проекта (с заменой конфигурации + из репозитория или дополнением), т.к. конфигурация должна быть доступна до начала клонирования проекта (В случае + веб-интерфейса, она берется из базы данных). + ### Этапы сборки