# 【GitHub】GitHub Actions で PHP を自動整形させる
> GitHub Actions で PHP_codesniffer を利用して PHP の自動整形させる方法。
- Canonical: https://c-a-p-engineer.github.io/github-actions-php_codesniffer/
- Published: 2021-10-21T22:00:00.000Z
- Modified: 2021-10-21T22:00:00.000Z
- Categories: PHP, Git
- Tags: PHP, Git, GitHub
GitHub Actions で `PHP_codesniffer` を利用して PHP の自動整形させる方法。
ちなみにプルリクなどの際にコードチェックしてくれるのは以下の方法で可能なようです。
chekalsky / phpcs-action
## PHP自動整形
先に以下のようにローカルで一度インストールして `composer.json` に入れるようにしてください。
```
composer require --dev "squizlabs/php_codesniffer"
```
※サンプルでは `master`ブランチにコミットする度に整形が走ります。
出来ればコミットログが汚くなるのが嫌であればローカルで実行するなりする方法を考えてください。
``` yml:/.github/workflows/phpcs-auto-commit.yml
name: PHP_CodeSniffier
on:
push:
branches:
- master
jobs:
create-rss:
runs-on: ubuntu-latest
steps:
# Checkout
- name: Checkout
uses: actions/checkout@v2
# Composer Install
- name: Install Dependencies
run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
# PHPCS
- name: PHPCS
run: ./vendor/bin/phpcbf .
# Commit
- name: Commit
if: ${{ failure() }}
uses: stefanzweifel/git-auto-commit-action@v4.2.0
with:
commit_message: PHPCS
```
`if: ${{ failure() }}` にしている理由ですが、 `PHP_codesniffer` では例え実行が成功しても **phpcbfは修正したエラーの量を返す** ようです。
* squizlabs/PHP_CodeSniffer - Gitter
## 参考
* squizlabs/PHP_CodeSniffer - Gitter