Permalink
Browse files

Specify general options on every plugin page, allowing customisation

Display list of additional general options on each individual plugin
page. This allows the list to be tweaked for specific plugins which
do not adhere to the exact same list of general plugins.

Make all examples use "yaml" format and be use 4 space indentation.

Fix various typos.

Add config file section names to some examples.
  • Loading branch information...
benr77 authored and corpsee committed Feb 8, 2019
1 parent 6c1b353 commit c06d824cfeaee82c06a191f365d765814ff2ee6a
Showing with 479 additions and 298 deletions.
  1. +0 −2 .gitignore
  2. +0 −2 docs/en/README.md
  3. +0 −15 docs/en/plugin_common_options.md
  4. +21 −8 docs/en/plugins/atoum.md
  5. +20 −6 docs/en/plugins/behat.md
  6. +9 −9 docs/en/plugins/campfire.md
  7. +1 −3 docs/en/plugins/clean_build.md
  8. +21 −21 docs/en/plugins/codeception.md
  9. +6 −8 docs/en/plugins/composer.md
  10. +3 −5 docs/en/plugins/copy_build.md
  11. +3 −5 docs/en/plugins/deployer.md
  12. +12 −12 docs/en/plugins/deployer_org.md
  13. +4 −2 docs/en/plugins/email.md
  14. +4 −2 docs/en/plugins/env.md
  15. +5 −5 docs/en/plugins/git.md
  16. +16 −3 docs/en/plugins/grunt.md
  17. +15 −2 docs/en/plugins/gulp.md
  18. +7 −6 docs/en/plugins/hipchat_notify.md
  19. +1 −1 docs/en/plugins/irc.md
  20. +23 −10 docs/en/plugins/lint.md
  21. +6 −17 docs/en/plugins/mage.md
  22. +7 −19 docs/en/plugins/mage3.md
  23. +19 −6 docs/en/plugins/pdepend.md
  24. +23 −9 docs/en/plugins/phan.md
  25. +3 −5 docs/en/plugins/phar.md
  26. +8 −9 docs/en/plugins/phing.md
  27. +18 −4 docs/en/plugins/php_code_sniffer.md
  28. +16 −3 docs/en/plugins/php_cpd.md
  29. +28 −15 docs/en/plugins/php_cs_fixer.md
  30. +20 −6 docs/en/plugins/php_docblock_checker.md
  31. +19 −6 docs/en/plugins/php_loc.md
  32. +29 −16 docs/en/plugins/php_mess_detector.md
  33. +22 −9 docs/en/plugins/php_parallel_lint.md
  34. +18 −5 docs/en/plugins/php_spec.md
  35. +21 −8 docs/en/plugins/php_tal_lint.md
  36. +4 −6 docs/en/plugins/php_unit.md
  37. +0 −2 docs/en/plugins/security_checker.md
  38. +1 −3 docs/en/plugins/sensiolabs_insight.md
  39. +13 −7 docs/en/plugins/shell.md
  40. +2 −1 docs/en/plugins/slack_notify.md
  41. +17 −4 docs/en/plugins/technical_debt.md
  42. +1 −1 docs/en/plugins/telegram.md
  43. +3 −5 docs/en/plugins/wipe.md
  44. +10 −5 docs/en/plugins/xmpp.md
@@ -1,5 +1,3 @@
.idea

/composer.phar

/vendor
@@ -34,8 +34,6 @@ Using PHP Censor
Plugins
-------

* [Common Plugin Configuration Options](plugin_common_options.md) - Details of the configuration options that are available for all plugins.

### Internal Plugins

#### Dependencies

This file was deleted.

Oops, something went wrong.
@@ -6,20 +6,33 @@ Allows you to run [Atoum](https://github.com/atoum/atoum) unit tests.
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **args** [string, optional] - Allows you to pass command line arguments to Atoum.
* **config** [string, optional] - Path to an Atoum configuration file.
Atom binary).

### Examples
```yml
test:
```yaml
test:
atoum:
args: "command line arguments go here"
config: "path to config file"
directory: "directory to run tests"
executable: "path to atoum executable"
args: "command line arguments go here"
config: "path to config file"
directory: "directory to run tests"
executable: "path to atoum executable"
```

### Additional Options

The following general options can also be used:

* **allow_failures** [bool, optional] - If true, allow the build to succeed even if this plugin fails.
* **directory** [string, optional] - This option lets you specify the tests directory to run.
* **ignore** [optional] - A list of files / paths to ignore (default: build_settings > ignore).
* **binary_name** [string|array, optional] - Allows you to provide a name of the binary.
* **binary_path** [string, optional] - Allows you to provide a path to the binary vendor/bin, or a system-provided.
* **priority_path** [string, optional] - Priority path for locating the plugin binary (Allowable values:
`local` (Local current build path) |
`global` (Global PHP Censor 'vendor/bin' path) |
`system` (OS System binaries path, /bin:/usr/bin etc.).
Default order: local -> global -> system)
@@ -6,16 +6,30 @@ A very simple plugin for running [Behat](http://behat.org/) BDD tests.
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **features** [string, optional] - Provide a list of Behat features to run.

### Examples
```yml
test:

```yaml
test:
behat:
executable: "path to behat binary"
features: "command line arguments"
executable: "path to behat binary"
features: "command line arguments"
```

### Additional Options

The following general options can also be used:

* **allow_failures** [bool, optional] - If true, allow the build to succeed even if this plugin fails.
* **directory** [string, optional] - This option lets you specify the tests directory to run.
* **ignore** [optional] - A list of files / paths to ignore (default: build_settings > ignore).
* **binary_name** [string|array, optional] - Allows you to provide a name of the binary.
* **binary_path** [string, optional] - Allows you to provide a path to the binary vendor/bin, or a system-provided.
* **priority_path** [string, optional] - Priority path for locating the plugin binary (Allowable values:
`local` (Local current build path) |
`global` (Global PHP Censor 'vendor/bin' path) |
`system` (OS System binaries path, /bin:/usr/bin etc.).
Default order: local -> global -> system)
@@ -7,8 +7,6 @@ This plugin joins a [Campfire](https://campfirenow.com/) room and sends a user-d
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **authToken** [string, required] - Your Campfire user authentication token.
@@ -17,13 +15,15 @@ See also [Common Plugin Configuration Options](../plugin_common_options.md).
* **url** [string, required] - Your Campfire chat room URL.

### Examples
```yml
build_settings:

```yaml
build_settings:
campfire:
authToken: "campfire auth token"
roomId: "campfire room ID"
url: "campfire URL"
success:
authToken: "campfire auth token"
roomId: "campfire room ID"
url: "campfire URL"
success:
campfire:
message: "Build succeeded!"
message: "Build succeeded!"
```
@@ -7,15 +7,13 @@ Build.
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **remove** - Required - An array of files and / or directories to remove.

### Examples

```yml
```yaml
complete:
clean_build:
remove:
@@ -6,8 +6,6 @@ A simple plugin that allows you to run [Codeception](http://codeception.com/) te
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **config** - Required - Can be either a single string pointing to a Codeception configuration file, or an array of
@@ -23,32 +21,34 @@ processing on line 146.

#### Default values

- config
- `codeception.yml` if it exists in the root of the project
- `codeception.dist.yml` if it exists in the root of the project
- null if no option provided and the above two fail, this will cause an Exception to be thrown on execution
* **config**
* `codeception.yml` if it exists in the root of the project
* `codeception.dist.yml` if it exists in the root of the project
* null if no option provided and the above two fail, this will cause an Exception to be thrown on execution

- args
- Empty string
* **args**
* Empty string

- output_path
- `tests/_output/`
- `test/_log`
* **output_path**
* `tests/_output/`
* `test/_log`

### Examples

```yml
codeception:
config: "codeception.yml"
args: "--no-ansi --coverage-html"
```yaml
tests:
codeception:
config: "codeception.yml"
args: "--no-ansi --coverage-html"
```

Or

```yml
codeception:
config: "subdir1/subdir2"
args: "report.xml -vv "
output_path:
- "subdir1/subdir2/tests/_output/"
```yaml
tests:
codeception:
config: "subdir1/subdir2"
args: "report.xml -vv "
output_path:
- "subdir1/subdir2/tests/_output/"
```
@@ -7,8 +7,6 @@ plugin.
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **action** [optional, string, update|install] - Action you wish Composer to run (default: 'install').
@@ -22,19 +20,19 @@ flag (default: false).

### Examples

```yml
```yaml
setup:
composer:
directory: "my/composer/dir"
action: "update"
prefer_dist: true
composer:
directory: "my/composer/dir"
action: "update"
prefer_dist: true
```

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
password inside the `auth.json` file. PHP Censor uses the `--no-interaction` flag, so it will not warn if you
must provide that info.

For more info, please check the Composer documentation.
@@ -7,10 +7,8 @@ of your choosing.
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **directory** - Required - The directory to which you want to copy the build.
* **respect_ignore** - Optional - Whether to respect the global "ignore" setting when copying files. Default is false.
* **wipe** - Optional - Set true if you want destination directory to be cleared before copying. Default is false.
* **directory** [string, required] - The directory to which you want to copy the build.
* **respect_ignore** [bool, optional] - Whether to respect the global "ignore" setting when copying files. Default is false.
* **wipe** [bool, optional] - Set true if you want destination directory to be cleared before copying. Default is false.
@@ -6,13 +6,11 @@ Triggers a deployment of the project to run via [Deployer](http://phpdeployment.
Configuration
-------------

See also [Common Plugin Configuration Options](../plugin_common_options.md).

### Options

* **webhook_url** [required, string] - The URL to your Deployer WebHook.
* **reason** [optional, string] - Your deployment message. Default - PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%
* **update_only** [optional, bool, true|false] - Whether the deployment should only be run if the currently deployed
* **webhook_url** [string, required] - The URL to your Deployer WebHook.
* **reason** [string, optional] - Your deployment message. Default - PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%
* **update_only** [bool, optional] - Whether the deployment should only be run if the currently deployed
branches matches the one being built (Default: true).

### Examples
@@ -14,28 +14,28 @@ default value that is "deploy"), stage name(it would be just server name or defi
Plugin options
--------------

* stage(*required*) - Stage or server name
* task(*optional*) - Task name (*default task is deploy*)
* verbosity(*optional*) - Add verbose mode to plugin execution (*default is no verbose that equal to normal in the
* **stage** [string, required] - Stage or server name
* **task** [string, optional] - Task name (*default task is deploy*)
* **verbosity** [string, optional] - Add verbose mode to plugin execution (*default is no verbose that equal to normal in the
option list of values below*)
* normal
* verbose
* very verbose
* debug
* quiet
* file(*optional*) - Filename of deployer configuration. For default deployer takes deploy.php if this field is not
* **file** [string, optional] - Filename of deployer configuration. For default deployer takes deploy.php if this field is not
specified

Sample configuration
--------------------

```
```yaml
\Ket4yii\PHPCensor\Deployer\Plugin\Deployer:
development: # branch name
task: sample-task # optional, default task is deploy
stage: dev # required, name of stage or server
verbose: debug # optional, default is normal(no verbosity)
file: .deploy_config.php # optional, deployer takes the deploy.php file for default
master:
stage: prod #required, name of stage or server
development: # branch name
task: sample-task # optional, default task is deploy
stage: dev # required, name of stage or server
verbose: debug # optional, default is normal(no verbosity)
file: .deploy_config.php # optional, deployer takes the deploy.php file for default
master:
stage: prod #required, name of stage or server
```
@@ -22,15 +22,17 @@ Configuration
See [Adding PHP Censor Support to Your Projects](../configuring_project.md) for more information about how to configure plugins.

Send an email to the committer as well as one@exameple.com if a build fails:
```yml

```yaml
failure:
email:
committer: true
default_mailto_address: one@example.com
```

Send an email to one@example.com every time a build is run:
```yml

```yaml
complete:
email:
default_mailto_address: one@example.com
@@ -6,9 +6,11 @@ Sets environment variables on the PHP Censor server for the build.
Configuration
-------------

### Examples:
None.

```yml
### Examples

```yaml
setup:
env:
APPLICATION_ENV: "development"
@@ -8,12 +8,12 @@ Configuration

### Examples

```yml
```yaml
complete:
git:
master: <-- branch
tag: <-- action
name: "" <-- Action options
git:
master: <-- branch
tag: <-- action
name: "" <-- Action options
```

Oops, something went wrong.

0 comments on commit c06d824

Please sign in to comment.