This action runs checks from DrupalQA on a Drupal code base. While you can directly use the Docker image with Github Actions, this Action makes it simpler to specify and configure some of the checks.

The PHP version to use (corresponds to the Docker image). Allowed options are and their corresponding Docker images are as follows. Default: 8.1.

Note: The actual Docker image used also depends on the registry option. If that option is set to 'ghcr' (default value), then the Docker image is prefixed with ghcr.io/. For example, ghcr.io/hussainweb/drupalqa:php8.2.

The web root (document root) to consider for default values for some of the checks. Default: web.

An YAML string describing the checks to run. The default structure is as below.

    checks: |
      phplint: {}
      phpcs: {}

The options for each of these are described in the DrupalQA checks section.

The registry to use to download the image. Only 'ghcr' and 'dockerhub' are supported. You probably don't need to change this option. It's only there to compare the performance and switch to DockerHub in case there is a problem with ghcr.io (which is unlikely). Default: ghcr.

No outputs.

uses: hussainweb/drupalqa@v1
with:
  php-version: 8.2
  checks: |
    phplint: {}
    phpcs:
      standard: phpcs.xml
    phpmd:
      ruleset: phpmd.xml

DrupalQA action supports configuring checks for the following tools.

These are the default options for phplint.

    checks: |
      phplint:
        exclude: vendor,web/core,web/modules/contrib
        extensions: php,module,theme,engine,inc,install
        verbose: ''
        path: ''

In the above sample, the paths begin with web as it is the default for web-root input. The actual default will depend on the web-root input.

phplint supports a .phplint.yml and can be run without any options. If you are using this, you can pass in the no_default_options option as follows.

    checks: |
      phplint:
        no_default_options: true

If you set this option to true, all other options are ignored.

These are the default options for phpcs. All are optional and you can override these as per the command line options of phpcs.

    checks: |
      phpcs:
        standard: Drupal,DrupalPractice
        extensions: php,module,inc,install,test,profile,theme
        ignore: ''
        path: web/modules/custom

In the above sample, the path begins with web as it is the default for web-root input. The actual default will depend on the web-root input.

You can specify multiple paths by separating them with a comma.

    checks: |
      phpcs:
        standard: Drupal,DrupalPractice
        path: web/modules/custom,web/themes/custom

These are the default options for phpmd. All are optional and you can override these as per the command line options of phpmd.

    checks: |
      phpmd:
        path: web/modules/custom
        format: text
        ruleset: codesize,naming,unusedcode
        suffixes: php,module,theme,engine,inc
        exclude: ''

In the above sample, the path begins with web as it is the default for web-root input. The actual default will depend on the web-root input.