【GitHub】GitHub Actions で PHP を自動整形させる
GitHub Actions で PHP_codesniffer を利用して PHP の自動整形させる方法。
ちなみにプルリクなどの際にコードチェックしてくれるのは以下の方法で可能なようです。
chekalsky / phpcs-action
PHP自動整形
先に以下のようにローカルで一度インストールして composer.json に入れるようにしてください。
composer require --dev "squizlabs/php_codesniffer"
※サンプルでは masterブランチにコミットする度に整形が走ります。
出来ればコミットログが汚くなるのが嫌であればローカルで実行するなりする方法を考えてください。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| 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は修正したエラーの量を返す ようです。
参考
