How do you set up your own sniff to run with GitHub actions?

[james-cnz]

I've written a sniff, and I'd like to use it to check a GitHub repository of mine. I don't see any instructions for this in the wiki. Does anyone have a simple example of this I could copy?

[asispts]

You can check these repos:

• https://github.com/asispts/ptscs/blob/main/.github/workflows/ci.yml
• https://github.com/slevomat/coding-standard/blob/master/.github/workflows/build.yml

[dingo-d]

WPCS also has a guide on setting up GH Actions, so you can check it out: https://github.com/WordPress/WordPress-Coding-Standards/wiki/Running-in-GitHub-Actions 👍🏼

[jrfnl]

@james-cnz It's not completely clear what you are asking.

If you are asking about setting up CI, then @asispts and @dingo-d both gave good links.

However, I wonder if you are asking about how to include the sniff in your ruleset ? Is that your problem ?

If so, have a look at the examples in the Annotated Ruleset wiki page.
I suspect you may be looking for this snippet:

 <!--
    If you are including sniffs that are not installed, you can
    reference the sniff class using an absolute or relative path
    instead of using the sniff code.
 -->
 <rule ref="/path/to/standards/Generic/Sniffs/Commenting/TodoSniff.php"/>
 <rule ref="../Generic/Sniffs/ControlStructures/InlineControlStructureSniff.php"/>

There is also a wiki page about creating sniffs in a (new) standard, which you may find helpful.

One thing to keep in mind - whether you are creating a (new) standard or not, sniffs do have to follow the PHPCS naming conventions (as outlined in the tutorial). Also see: #689

[james-cnz]

Hi @jrfnl,
I'm asking about setting up CI, but to use my own sniff, not one of the standard ones.
I have a PHP project I'd like to check that's on GitHub. I've written a phpcs sniff for checking it that's on my local machine. I'm currently running the sniff locally to check my project. I'd like the sniff to run automatically, through GitHub actions.

[jrfnl]

@james-cnz Okay, so is the sniff part of a project ? Has it been published somewhere or does it only live on your local machine ?
How do you run it locally at this moment ?

If the sniff is published somewhere AND it is available in your project (possible after setup via a composer install) AND you have it included in your project's local [.]phpcs.xml[.dist] file, the links posted above by @asispts and @dingo-d should tell you how to get it running on GH Actions.

[james-cnz]

OK, thanks. It's just on my local machine. I just open a console and run it at the command line. I figured I'd have to publish it somehow, though. Which comment do you think I should mark as answer, the first? (I assume I can only mark one.)

[jrfnl]

Feel free to mark whichever comment you found most helpful to solve your issue.