Update changelog, docs and dist files to show the new option

Author: stronk7

.travis.dist.yml

@@ -50,11 +50,11 @@ script:
   - moodle-plugin-ci phplint
   - moodle-plugin-ci phpcpd
   - moodle-plugin-ci phpmd
-  - moodle-plugin-ci phpcs
+  - moodle-plugin-ci phpcs --max-warnings 0
+  - moodle-plugin-ci phpdoc --max-warnings 0
   - moodle-plugin-ci validate
   - moodle-plugin-ci savepoints
   - moodle-plugin-ci mustache
   - moodle-plugin-ci grunt
-  - moodle-plugin-ci phpdoc --fail-on-warning
-  - moodle-plugin-ci phpunit
+  - moodle-plugin-ci phpunit --fail-on-warning
   - moodle-plugin-ci behat

docs/CHANGELOG.md

@@ -10,7 +10,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
 
 ## [Unreleased]
 ### Added
-- Add the `--testdox` option within the `phpunit` command.
+- Add the `--testdox` option to the `phpunit` command.
+- Add the `--max-warnings` option to the `phpdoc` command, so it behaves the same than the `phpcs` command. Note that this modifies current behaviour (see next point) and plugins with only warnings won't be failing any more.
+- ACTION SUGGESTED: In order to keep the previous behaviour, it's recommended to use the new `--max-warnings 0` (or any other number) option to specify the warnings threshold.
 
 ### Changed
 - Updated project dependencies to current [moodle-cs](https://github.com/moodlehq/moodle-cs), [moodle-local_moodlecheck](https://github.com/moodlehq/moodle-local_moodlecheck) and [moodle-local_ci](https://github.com/moodlehq/moodle-local_ci) versions. Also, to various internal / development tools.

docs/GHAFileExplained.md

@@ -150,7 +150,7 @@ jobs:
 
       - name: Moodle PHPDoc Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci phpdoc
+        run: moodle-plugin-ci phpdoc --max-warnings 0
 
       - name: Validating
         if: ${{ always() }}

docs/Help.md

@@ -45,7 +45,7 @@ you keep this step.  To fail on warnings use `--max-warnings 0`
 
 **moodle-plugin-ci phpdoc**
 
-This step runs Moodle PHPDoc checker on your plugin.
+This step runs Moodle PHPDoc checker on your plugin. To fail on warnings use `--max-warnings 0`
 
 **moodle-plugin-ci validate**
 

docs/TravisFileExplained.md

@@ -136,6 +136,7 @@ script:
 # To fail on warnings use --max-warnings 0
   - moodle-plugin-ci phpcs
 # This step runs Moodle PHPDoc checker on your plugin.
+# To fail on warnings use --max-warnings 0
   - moodle-plugin-ci phpdoc
 # This step runs some light validation on the plugin file structure
 # and code.  Validation can be plugin specific.

gha.dist.yml

@@ -85,7 +85,7 @@ jobs:
 
       - name: Moodle PHPDoc Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci phpdoc
+        run: moodle-plugin-ci phpdoc --max-warnings 0
 
       - name: Validating
         if: ${{ always() }}