regression-report.yml

This workflow allows user/contributor to trigger regression/diff report for changes that they have in Pull Request(PR).

Workflow does:

• takes configurations from user's PR comment or/and PR description,
• builds checkstyle from master branch,
• run checkstyle validation for user defined list of project with user defined configs
• stores results of validation
• builds checkstyle from PR branch,
• run checkstyle validation for user defined list of project with user defined configs
• stores results of validation
• compares results of validation from both execution, generate html report
• share html report link back to PR

There are few way to trigger diff report.

Make a comment in PR:

GitHub, generate report by config from InputXxxxxx.java

or

GitHub, generate report by config from some/path/InputXxxxxx.java

Workflow will find InputXxxxxx.java in repository, take config from it and will use for diff report generation. Workflow will use default list of projects that is located at test-configs repository.

Make a comment in PR:

GitHub, generate report for {{folder in https://github.com/checkstyle/test-configs}}

Workflow will download config.xml and list-of-projects.yml from test-configs repository, use then for diff report generation.

Add the links of the config files in the PR description as described at checkstyle-tester

Make a comment in PR:

Github, generate report for configs in PR description

If you plan to frequently use regression/diff report, it is recommended to use "Saved Reply" GitHub feature of your GitHub account.

Usage: by button in web UI, by slash command