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

A GitHub action that runs a phpcs and reports the result to reviewdog
https://github.com/reload/action-phpcs

hacktoberfest

Last synced: about 4 hours ago
JSON representation

A GitHub action that runs a phpcs and reports the result to reviewdog

• Host: GitHub
• URL: https://github.com/reload/action-phpcs
• Owner: reload
• Created: 2021-07-17T19:47:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-11T14:18:55.000Z (8 months ago)
• Last Synced: 2024-03-11T15:43:28.395Z (8 months ago)
• Topics: hacktoberfest
• Language: Shell
• Homepage:
• Size: 35.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# action-phpcs

A GitHub action that runs a phpcs and reports the result to reviewdog

# Prerequisites

* Composer install has been executed

* Phpcs is install by composer and available in the composer config bin-dir

* The code styles used by phpcs are installed and confgured in the .phpcs.xml

# Usage

Add a workflow step with the action:

```yaml

steps:

  - name: Run phpcs

    uses: reload/action-phpcs@

    with:

      reviewdog_token: ${{ secrets.GITHUB_TOKEN }}`

```

A sub path can be given to the action if the composer.json file is not in the root of the working directory.

Example:

```yaml

steps:

  - name: Run phpcs

    uses: reload/action-phpcs@

    with:

      path: drupal

      reviewdog_token: ${{ secrets.GITHUB_TOKEN }}`

```