Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Add list of supported tools and how to ensure the checks are being properly generated #105

Open
boesing opened this issue Jul 5, 2022 · 0 comments

Comments

@boesing
Copy link
Member

boesing commented Jul 5, 2022

Feature Request

Q A
New Feature no
RFC no
BC Break no

Summary

This component supports some tools for CI pipeline, such as:

  • PHPCodeSniffer
  • Psalm
  • PHPUnit
  • PHP-CS-Fixer
  • etc.

(List of supported tools can be found in this file)

At least for one tool (PHP-CS-Fixer), we require a project to have a composer-require-checker.json configuration file available. This is because the tool does not have a default filename for this and thus, we decided to go with this filename.

For infection, we do support the static-analysis tool from Roave as well, but do not list it anywhere in the README or docs.

So this Issue is to ensure we do improve the documentation of this github action so that every1 who wants to use this CI Pipeline is aware of how to configure the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant