deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fixed headlines in docs

Browse source
This commit is contained in:
Dmitry Khomutov 2017-01-04 19:22:20 +07:00
commit 4692999337
51 changed files with 119 additions and 119 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/en/plugins/atoum.md
View file

@ -1,10 +1,10 @@
Plugin Atoum
------------
============
Allows you to run [Atoum](https://github.com/atoum/atoum) unit tests.
Configuration
=============
-------------
### Options

4
docs/en/plugins/behat.md
View file

@ -1,10 +1,10 @@
Plugin Behat
------------
============
A very simple plugin for running [Behat](http://behat.org/) BDD tests.
Configuration
=============
-------------
### Options

4
docs/en/plugins/campfire.md
View file

@ -1,10 +1,10 @@
Plugin Campfire
---------------
===============
This plugin joins a [Campfire](https://campfirenow.com/) room and sends a user-defined message, for example a "Build Succeeded" message.
Configuration
=============
-------------
### Options

4
docs/en/plugins/clean_build.md
View file

@ -1,10 +1,10 @@
Plugin Clean build
------------------
==================
Works through a list of files to remove from your build. Useful when used in combination with Copy Build or Package Build.
Configuration
=============
-------------
### Options

4
docs/en/plugins/codeception.md
View file

@ -1,10 +1,10 @@
Plugin Codeception
------------------
==================
A simple plugin that allows you to run [Codeception](http://codeception.com/) tests.
Configuration
=============
-------------
### Options

6
docs/en/plugins/composer.md
View file

@ -1,10 +1,10 @@
Plugin Composer
---------------
===============
Allows you to run Composer within your build, to install dependencies prior to testing. Best run as a "setup" stage plugin.
Configuration
=============
-------------
### Options
@ -26,7 +26,7 @@ setup:
```
Warning
=======
-------
If you are using a Composer private repository like Satis, with HTTP authentication, you must check your username and password inside the ```auth.json``` file. PHP Censor uses the ```--no-interaction``` flag, so it will not warn if you must provide that info.

4
docs/en/plugins/copy_build.md
View file

@ -1,10 +1,10 @@
Plugin Copy Build
-----------------
=================
Copies all files from your build, with the exception of those in the "ignore" build settings property, to a directory of your choosing.
Configuration
=============
-------------
### Options

4
docs/en/plugins/deployer.md
View file

@ -1,10 +1,10 @@
Plugin Deployer
---------------
===============
Triggers a deployment of the project to run via [Deployer](http://phpdeployment.org)
Configuration
=============
-------------
### Options

4
docs/en/plugins/email.md
View file

@ -1,10 +1,10 @@
Plugin Email
------------
============
Sends a build status email.
Configuration
=============
-------------
### Options

4
docs/en/plugins/env.md
View file

@ -1,10 +1,10 @@
Plugin Env
----------
==========
Sets environment variables on the PHP Censor server for the build.
Configuration
=============
-------------
### Examples:

4
docs/en/plugins/grunt.md
View file

@ -1,10 +1,10 @@
Plugin Grunt
------------
============
This plugin runs [Grunt](http://gruntjs.com/) tasks.
Configuration
=============
-------------
### Options

4
docs/en/plugins/hipchat_notify.md
View file

@ -1,10 +1,10 @@
Plugin Hipchat Notify
---------------------
=====================
This plugin joins a [HipChat](https://www.hipchat.com/) room and sends a user-defined message, for example a "Build Succeeded" message.
Configuration
=============
-------------
### Options

4
docs/en/plugins/irc.md
View file

@ -1,10 +1,10 @@
Plugin IRC
----------
==========
Connects to an IRC server and sends a defined message.
Configuration
=============
-------------
### Options

4
docs/en/plugins/lint.md
View file

@ -1,10 +1,10 @@
Plugin Lint
-----------
===========
This plugin runs PHP's built in Lint (syntax / error check) functionality.
Configuration
=============
-------------
### Options

4
docs/en/plugins/mysql.md
View file

@ -1,10 +1,10 @@
Plugin MySQL
------------
============
Connects to a given MySQL server and runs a selection of queries.
Configuration
=============
-------------
### Examples

4
docs/en/plugins/package_build.md
View file

@ -1,10 +1,10 @@
Plugin Package Build
--------------------
====================
Builds a tar or zip archive of your build and places it in a directory of your choosing.
Configuration
=============
-------------
### Options

4
docs/en/plugins/pdepend.md
View file

@ -1,10 +1,10 @@
Plugin Pdepend
--------------
==============
Runs [PDepend](http://pdepend.org/) software metrics.
Configuration
=============
-------------
### Options

4
docs/en/plugins/pgsql.md
View file

@ -1,10 +1,10 @@
Plugin PostgreSQL
-----------------
=================
Connects to a given PostgreSQL server and runs a list of queries.
Configuration
=============
-------------
### Examples

4
docs/en/plugins/phar.md
View file

@ -1,10 +1,10 @@
Plugin Phar
-----------
===========
Allows you to create a [Phar](http://php.net/manual/en/book.phar.php) archive from your project.
Configuration
=============
-------------
### Options

4
docs/en/plugins/phing.md
View file

@ -1,10 +1,10 @@
Plugin Phing
------------
============
This plugin allows you to use the Phing build system to build your project.
Configuration
=============
-------------
### Options

4
docs/en/plugins/php_code_sniffer.md
View file

@ -1,10 +1,10 @@
Plugin PHP Code Sniffer
-----------------------
=======================
Runs PHP Code Sniffer against your build.
Configuration
=============
-------------
### Options

4
docs/en/plugins/php_cpd.md
View file

@ -1,10 +1,10 @@
Plugin PHP Copy/Paste Detector
------------------------------
==============================
Runs PHP Copy/Paste Detector against your build.
Configuration
=============
-------------
### Options

6
docs/en/plugins/php_cs_fixes.md
View file

@ -1,10 +1,10 @@
Plugin PHP Coding Standards Fixer
---------------------------------
=================================
Runs PHP Coding Standards Fixer against your build.
Configuration
=============
-------------
### Options
@ -25,6 +25,6 @@ test:
```
Warning
=======
-------
There is currently a bug with this plugin that will cause an error if you leave the level to default to `all`. That level does not exist and will cause the build to fail. Instead specify the level explicitly until this is fixed.

4
docs/en/plugins/php_docblock_checker.md
View file

@ -1,10 +1,10 @@
Plugin PHP Docblock Checker
---------------------------
===========================
Runs the PHP Docblock Checker against your build. This tool verifies that all classes and methods have docblocks.
Configuration
=============
-------------
### Options

6
docs/en/plugins/php_loc.md
View file

@ -1,10 +1,10 @@
Plugin PHPLoc
-------------
=============
Runs [PHPLoc](https://github.com/sebastianbergmann/phploc) against your project and records some key metrics.
Configuration
=============
-------------
### Options
@ -12,7 +12,7 @@ Configuration
### Example
Run PHPLOC against the app directory only. This will prevent inclusion of code from 3rd party libraries that are included outside of the app directory.
Run PHPLoc against the app directory only. This will prevent inclusion of code from 3rd party libraries that are included outside of the app directory.
```yml
test:

4
docs/en/plugins/php_mess_detector.md
View file

@ -1,10 +1,10 @@
Plugin PHP Mess Detector
------------------------
========================
Runs PHP Mess Detector against your build. Records some key metrics, and also reports errors and warnings.
Configuration
=============
-------------
### Options

4
docs/en/plugins/php_parallel_lint.md
View file

@ -1,10 +1,10 @@
Plugin PHP Parallel Lint
------------------------
========================
Similar to the [standard PHP Lint plugin](lint.md), except that it uses the [PHP Parallel Lint](https://github.com/JakubOnderka/PHP-Parallel-Lint) project to run.
Configuration
=============
-------------
### Options

4
docs/en/plugins/php_spec.md
View file

@ -1,10 +1,10 @@
Plugin PHP Spec
---------------
===============
Runs [PHP Spec](http://www.phpspec.net/) tests against your build.
Configuration
=============
-------------
### Options

6
docs/en/plugins/php_unit.md
View file

@ -1,10 +1,10 @@
Plugin PHPUnit
--------------
==============
Runs PHPUnit tests against your build.
Configuration
=============
-------------
### Options
@ -37,7 +37,7 @@ test:
```
Troubleshooting
===============
---------------
If standard logging of PHP Censor is not enough, to get standard output from any command, including PHPUnit, edit `BaseCommandExecutor::executeCommand()` to see what exactly is wrong
* Run `composer update` in phpunit plugin directory of PHP Censor to get all of its dependencies

4
docs/en/plugins/shell.md
View file

@ -1,10 +1,10 @@
Plugin Shell
------------
============
Runs a given Shell command.
Configuration
=============
-------------
### Options

4
docs/en/plugins/slack_notify.md
View file

@ -1,10 +1,10 @@
Plugin Slack Notify
-------------------
===================
This plugin joins a [Slack](https://www.slack.com/) room and sends a user-defined message, for example a "Build Succeeded" message.
Configuration
=============
-------------
### Options

4
docs/en/plugins/sqlite.md
View file

@ -1,10 +1,10 @@
Plugin SQLite
-------------
=============
Connects to a given SQLite DB and runs a list of queries.
Configuration
=============
-------------
### Examples

4
docs/en/plugins/technical_dept.md
View file

@ -1,10 +1,10 @@
Plugin Technical Dept
---------------------
=====================
Checks all files in your project for TODOs and other technical debt.
Configuration
=============
-------------
### Options

8
docs/en/plugins/xmpp.md
View file

@ -1,19 +1,19 @@
Plugin XMPP
-----------
===========
Requirements
============
------------
- sendxmpp package
Installation
============
------------
1. On debian system (for example) use aptitude command to install sendxmpp
2. Add XMPP plugin in "complete" section of your `php-censor.yml`
Configuration
=============
-------------
### Options