Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.85 KB

phpmd.md

File metadata and controls

50 lines (35 loc) · 1.85 KB

phpmd

Runs phpmd reports and creates an artifact for this

Inputs:

title: not required, default: shop_ce
Title used in the file names for the phpmd reports. Set to module ids for a module.

source_path: not required, default: source
A folder to run the phpmd in.

report_path: not required, default: reports
Name of the folder to store the generated reports and PHP error log in.

config: not required, default: tests/PhpMd/standard.xml
Name of the configuration file for phpmd.

baseline_file: not required, default: tests/PhpMd/phpmd.baseline.xml
Path to a phpmd baseline file.

additional_options: not required, default: ''
Additional options to pass to phpmd.

verbose: not required, default: false
If set to true, not only phpmd-report but an additional phpmd run with text output will be executed. This output is visible in the github logs and will be saved in the archive.

generate_baseline: not required, default: false
If set to true, we will generate a phpmd baseline file and save it in the actions output. This can then be moved to the tests/PhpMd folder of the repo to replace the old baseline.

container_name: not required, default: php
Name of the container to run the test in.

container_options: not required, default: ''
Options to pass to the container start.

container_method: not required, default: 'exec'
Whether we use exec to run the command in the existing php container or run to spin up a new one.

output_artifact: not required, default: phpmd
Github run artifact to put the output files in.

failure_pattern: not required, default: '"warnings":|"violations":|"errors":'
Grep pattern which indicate that the test failed.

debug: not required, default: ''
Code snippet to generate the debugging code

Outputs:

none