4.5.0

Changed

• Updated project dependencies to current moodle-cs v3.4.7 and moodle-local_ci v1.0.30 releases.
• Internal, various improvements to self testing.

Deprecated

• The use of phpdbg to calculate PHPUnit's code-coverage has been deprecated in this moodle-plugin-ci release (4.5.0) and will be removed in 5.0.0. This includes both the implicit (default) option when no alternative (pcov or xdebug) is available and the explicit --coverage-phpdbg option.
• ACTION SUGGESTED: In order to avoid deprecation warnings or annotations, proceed to ensure that either pcov (Moodle 3.10 and up) or xdebug are available and they will be used automatically. Note that any use of phpdbg will throw an error in the next major release (5.0.0).

Fixed

• Solved a problem with the validation of dataformat plugin lang strings.
• Fixed a problem with the phpcs command returning with success when some (configuration, installation, ...) problem was causing it not to be executed at all.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.4.5

Changed

• Additional release for error in release process

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.4.3

Changed

• Updated project dependencies to current moodle-cs v3.4.5 release.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.4.2

Added

• Added GHA step to store Behat fail-dumps as workflow artefacts, so it can be
  inspected. Documentation has been updated as well to reflect the purpose of the step.
• Added support for the --license-regex option to the phpcs command. When specified, all the PHPDoc license tags (@license) are inspected to ensure that they contain some text matching the regular expression (a license type: /GNU GPL v3 or later/, ... or any other valid alternative).

Changed

• Updated project dependencies to current moodle-cs v3.4.4, moodle-local_moodlecheck v1.3.2 and moodle-local_ci v1.0.29 releases.
• Updated self CI dependencies to current PHP and Moodle versions.
• For pull requests, set the Assignee automatically (to the author of the PR).

Removed

• The documentation about the phpcpd command (deprecated and to be removed in 5.0.0) has been deleted from all the templates and docs.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.4.1

Added

• New --no-plugin-node option added to the install command, to be able to skip the installation of any NodeJS stuff that the plugin may include. The previous default has not changed and both Moodle's and plugin's NodeJS installation continues happening normally.

Changed

• Updated project dependencies to current moodle-cs v3.4.1, moodle-local_moodlecheck v1.3.0 and moodle-local_ci v1.0.28 releases.

Fixed

• Some small fixes to documentation.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.4.0

Added

• New --selenium option or MOODLE_BEHAT_SELENIUM_IMAGE env variable to the behat command, to be able to specify the Selenium Docker image to use (defaults apply if not specified).
• New MOODLE_BEHAT_CHROME_CAPABILITIES and MOODLE_BEHAT_FIREFOX_CAPABILITIES env variables to configure additional browser capabilities (they will be needed - internally - soon, to allow the command to perform some special behat runs).
• Extend own CI tests to cover:
  • PHP 8.3 (all tests).
  • selfupdate PHAR command (unit and integration tests).

Changed

• Updated all uses of actions/checkout from v3 (using node 16) to v4 (using node 20), because actions using node 16 are deprecated and will stop working in the future.
• ACTION SUGGESTED: In order to avoid the node 16 deprecation warnings, update your workflows to use actions/checkout@v4. Note: the same may apply to other actions being used in your workflows (check your latest runs).
• Updated project dependencies to current moodle-cs.

Deprecated

• The phpcpd command (that uses the PHP Copy/Paste Detector, now abandoned) has been deprecated in this moodle-plugin-ci release (4.4.0) and will be removed in 5.0.0. No replacement is planned.
• ACTION SUGGESTED: In order to avoid deprecation warnings or annotations, proceed to remove this command from your workflows. Note that any use will throw an error in the next major release (5.0.0).
• The master branch of Moodle upstream repositories has been moved to main and will stop working soon (see MDLSITE-7418 for details). GitHub workflows will start emitting warnings/annotations when uses of the master branch are detected.
• ACTION SUGGESTED: In order to avoid deprecation warnings or annotations, proceed to replace master by main in your workflows. Note that any use of the former (to be removed) will throw an error in the future.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.3.2

Changed

• Modified internal CI scripts towards better Codecov future support.
• Updated project dependencies to current moodle-cs.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.3.1

Added

• Added support for the --todo-comment-regex option to the phpcs command. When specified, all the todo comments (TODO and @todo) are inspected to ensure that they contain some text matching the regular expression (a tracker issue key: MDL-[0-9]+, a link to GitHub: github.com/moodle/moodle/pull/[0-9]+, ... or any other valid alternative).

Changed

• Updated project dependencies to current moodle-cs and moodle-local_ci versions.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.3.0

Added

• Added Moodle App Behat testing support.
• Added support for the --exclude option to the phpcs command.

Changed

• Updated project dependencies to current moodle-cs and moodle-local_ci versions.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.

4.2.0

Added

• Added support for the --tags and --name options to the behat command.
• Added support for the --configure, --testsuite and --filter options to the phpunit command.

Changed

• The default branch of this repository has been renamed from master to main. You can visit this issue (#258) for more information about the potential actions required (if you use this, or clones/forks of this, repository).

• ACTION SUGGESTED: If you are using GitHub Actions, it's recomended to use !cancelled() instead of always() for moodle-plugin-ci tests. Adding a final step that always returns failure when the workflow is cancelled will ensure that cancelled workflows are not marked as successful. For a working example, please reference the updated gha.dist.yml file.

• ACTION SUGGESTED: For some (unknown) reason, Travis environments with PHP 8.2 have started to fail with error:

  php: error while loading shared libraries: libonig.so.5
  

  To avoid that problem, it's recommended to to add the libonig5 package to the travis.yml file. For a working example, please reference the updated .travis.dist.ymlfile.

• Updated project dependencies to current moodle-cs and moodle-local_moodlecheck versions.

Take a look at the CHANGELOG for details about other releases.
Please follow the 4.0 Upgrade guide when upgrading from 3.x.