https://github.com/shirobrak/action-phpcs

Run phpcs with reviewdog
https://github.com/shirobrak/action-phpcs

github-actions phpcs

Last synced: about 2 months ago
JSON representation

Run phpcs with reviewdog

• Host: GitHub
• URL: https://github.com/shirobrak/action-phpcs
• Owner: shirobrak
• License: mit
• Created: 2020-08-30T05:04:56.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-11-16T12:38:21.000Z (over 3 years ago)
• Last Synced: 2026-03-28T16:24:26.161Z (about 2 months ago)
• Topics: github-actions, phpcs
• Language: Shell
• Homepage:
• Size: 233 KB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub Action: Run phpcs with reviewdog

[![Docker Image CI](https://github.com/shirobrak/action-phpcs/workflows/Docker%20Image%20CI/badge.svg)](https://github.com/shirobrak/action-phpcs/actions)

[![depup](https://github.com/shirobrak/action-phpcs/workflows/depup/badge.svg)](https://github.com/shirobrak/action-phpcs/actions?query=workflow%3Adepup)

[![release](https://github.com/shirobrak/action-phpcs/workflows/release/badge.svg)](https://github.com/shirobrak/action-phpcs/actions?query=workflow%3Arelease)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/shirobrak/action-phpcs?logo=github&sort=semver)](https://github.com/shirobrak/action-phpcs/releases)

[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)

This action runs [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) with [reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve code review experience.

![](imgs/github-checks.png)

![](imgs/github-pr-review.png)

## Inputs

### `github_token`

**Required**. Default is `${{ github.token }}`.

### `level`

Optional. Report level for reviewdog [info,warning,error]. It's same as -level flag of reviewdog.

### `reporter`

Reporter of reviewdog command [github-pr-check,github-check,github-pr-review]. Default is github-pr-check. It's same as -reporter flag of reviewdog.

github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

### `filter_mode`

Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added.

### `fail_on_error`

Optional. Exit code for reviewdog when errors are found [true,false]. Default is false.

### `reviewdog_flags`

Optional. Additional reviewdog flags

### `phpcs_flags`

Optional. Flags and args of phpcs command. Default: '.'

### `workdir`

Optional. The directory from which to look for and run phpcs. Default '.'

## Example usage

You also need to install [phpcs](https://github.com/squizlabs/PHP_CodeSniffer).

How to install phpcs is [here](https://github.com/squizlabs/PHP_CodeSniffer#installation).

### [.github/workflows/reviewdog.yaml](./.github/workflows/reviewdog.yaml)

```yaml

name: reviewdog

on: [pull_request]

jobs:

  phpcs:

    name: runner / phpcs

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: phpcs

        uses: shirobrak/action-phpcs@v1.0.0

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          reporter: github-pr-review  # Change reporter.

          phpcs_flags: '--standard=phpcs.xml src/'

```