{"repo":"rtCamp/action-phpcs-code-review","free":true,"listed":false,"github":"https://github.com/rtCamp/action-phpcs-code-review","clone":"git clone https://github.com/rtCamp/action-phpcs-code-review.git","description":"Github Action to perform automated code review on pull requests","language":"Shell","stars":117,"topics":["github-actions","php","phpcs","phpcs-report","tier-2"],"license":"MIT","category":"workflow-automation","readme_excerpt":"This action is a part of GitHub Actions Library created by rtCamp. PHPCS Code Review - GitHub Action A GitHub Action to perform automated pull request review. It is based on https://github.com/Automattic/vip-go-ci/ but can be used for any WordPress or even PHP projects. The code review is performed using PHPCS. Please note that, this action performs pull request review only . If you have an existing project, and you want entire project's code to be reviwed, you may need to do it manually. Usage 1. Create a .github/workflows/phpcs.yml in your GitHub repo, if one doesn't exist already. 2. Add the following code to the phpcs.yml file. 3. Define GH BOT TOKEN using GitHub Action's Secret. See GitHub Token Creation section for more details. Now, next time you create a pull request or commit on an existing pull request, this action will run. By default, pull request will be reviwed using WordPress coding and documentation standards. You can change the default by passing different PHPCS Coding Standard(s) in line args = [\"WordPress-Core,WordPress-Docs\"] . 4. In case you want to skip PHPCS scanning in any pull request, add [do-not-scan] in the PR description. You can add it anywhere in the description and it will skip the action run for that pull request. 5. In case you want to skip linting all files on every pull request, set PHP LINT to false . GitHub Token Creation You can create GitHub Token from here. It is necessary that you create this token from a bot user account. Please note","default_branch":null,"files":null,"tree":[],"storefront":"/r/rtCamp","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rtCamp/action-phpcs-code-review/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}