rtcamp/action-phpcs-code-review

PHPCS代码审查 - GitHub Action

![项目状态：活跃 – 项目已达到稳定可用状态且正在积极开发中。]([***]

镜像概述和主要用途

此Action是https://github.com/rtCamp/github-actions-library/%E7%9A%84%E4%B8%80%E9%83%A8%E5%88%86%EF%BC%8C%E7%94%B1https://github.com/rtCamp/%E5%88%9B%E5%BB%BA%E3%80%82%E5%AE%83%E6%98%AF%E4%B8%80%E4%B8%AA%E7%94%A8%E4%BA%8E%E6%89%A7%E8%A1%8C%E8%87%AA%E5%8A%A8%E5%8C%96https://help.github.com/en/articles/about-pull-request-reviews%E7%9A%84GitHub Action，基于https://github.com/Automattic/vip-go-ci/%EF%BC%8C%E5%8F%AF%E7%94%A8%E4%BA%8E%E4%BB%BB%E4%BD%95WordPress%E7%94%9A%E8%87%B3PHP%E9%A1%B9%E7%9B%AE%E3%80%82%E4%BB%A3%E7%A0%81%E5%AE%A1%E6%9F%A5%E9%80%9A%E8%BF%87https://github.com/squizlabs/PHP_CodeSniffer%E6%89%A7%E8%A1%8C%E3%80%82%E8%AF%B7%E6%B3%A8%E6%84%8F%EF%BC%8C%E6%AD%A4Action%E4%BB%85%E6%89%A7%E8%A1%8C%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E5%AE%A1%E6%9F%A5%EF%BC%9B%E8%8B%A5%E9%9C%80%E5%AE%A1%E6%9F%A5%E7%8E%B0%E6%9C%89%E9%A1%B9%E7%9B%AE%E7%9A%84%E5%85%A8%E9%83%A8%E4%BB%A3%E7%A0%81%EF%BC%8C%E9%9C%80%E6%89%8B%E5%8A%A8%E8%BF%9B%E8%A1%8C%E3%80%82

核心功能和特性

• 基于PHPCS进行自动化代码规范检查
• 支持自定义PHPCS编码标准
• 可排除指定文件夹和特定嗅探规则
• 通过环境变量灵活配置行为
• 支持配置文件自定义机器人审查行为
• 可跳过对草稿PR或特定PR的扫描
• 支持自定义PHP_CodeSniffer规则集文件

使用场景和适用范围

适用于需要对WordPress或PHP项目的拉取请求进行自动化代码规范检查的开发团队，尤其适合希望确保代码符合项目编码标准、减少人工审查成本的场景。

详细使用方法和配置说明

用法

1. 在GitHub仓库中创建.github/workflows/phpcs.yml（若不存在）。
2. 向phpcs.yml文件添加以下代码：

yaml
on: pull_request

name: Inspections
jobs:
  runPHPCSInspection:
    name: Run PHPCS inspection
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        ref: ${{ github.event.pull_request.head.sha }}
    - name: Run PHPCS inspection
      uses: rtCamp/action-phpcs-code-review@v2
      env:
        GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
        SKIP_FOLDERS: "tests,.github"
        PHPCS_SNIFFS_EXCLUDE: "WordPress.Files.FileName"
      with:
        args: "WordPress,WordPress-Core,WordPress-Docs"

3. 使用https://developer.github.com/actions/creating-workflows/storing-secrets%E5%AE%9A%E4%B9%89%60GH_BOT_TOKEN%60%E3%80%82%E8%AF%A6%E8%A7%81GitHub%E4%BB%A4%E7%89%8C%E5%88%9B%E5%BB%BA%E9%83%A8%E5%88%86%E3%80%82

创建拉取请求或在现有拉取请求上提交时，此Action将自动运行。默认使用WordPress编码和文档标准进行审查，可通过在args: "WordPress,WordPress-Core,WordPress-Docs"行中传递不同的PHPCS编码标准修改默认设置。

4. 若需在特定拉取请求中跳过PHPCS扫描，可在PR描述中添加[do-not-scan]（可位于描述任何位置）。

5. 若需跳过对所有PHP文件的默认自动linting，可将PHP_LINT设置为false。

GitHub令牌创建

可从https://github.com/settings/tokens%E5%88%9B%E5%BB%BAGitHub%E4%BB%A4%E7%89%8C%E3%80%82**%E5%BF%85%E9%A1%BB**%E4%BD%BF%E7%94%A8%E6%9C%BA%E5%99%A8%E4%BA%BA%E7%94%A8%E6%88%B7%E8%B4%A6%E6%88%B7%E5%88%9B%E5%BB%BA%E6%AD%A4%E4%BB%A4%E7%89%8C%E3%80%82%E8%AF%B7%E6%B3%A8%E6%84%8F%EF%BC%8C%E8%8B%A5%E4%BB%93%E5%BA%93%E4%B8%BA%E7%A7%81%E6%9C%89%E4%BB%93%E5%BA%93%EF%BC%8C%E6%9C%BA%E5%99%A8%E4%BA%BA%E8%B4%A6%E6%88%B7%E5%BF%85%E9%A1%BB%E6%9C%89%E6%9D%83%E8%AE%BF%E9%97%AE%E8%AF%A5%E4%BB%93%E5%BA%93%E3%80%82%E4%BD%BF%E7%94%A8%E6%9C%BA%E5%99%A8%E4%BA%BA%E8%B4%A6%E6%88%B7%E7%9A%84%E5%8E%9F%E5%9B%A0%E6%98%AF%EF%BC%9A%E5%9C%A8GitHub%E4%B8%AD%EF%BC%8C%E4%B8%8D%E5%85%81%E8%AE%B8%E7%94%A8%E6%88%B7%E5%AF%B9%E8%87%AA%E5%B7%B1%E7%9A%84%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E8%AF%B7%E6%B1%82%E6%9B%B4%E6%94%B9%EF%BC%9B%E6%AD%A4%E5%A4%96%EF%BC%8C%E5%9C%A8%E5%A4%A7%E5%9E%8B%E5%9B%A2%E9%98%9F%E4%B8%AD%EF%BC%8C%E4%BD%BF%E7%94%A8%E4%B8%AA%E4%BA%BA%E8%B4%A6%E6%88%B7%E4%BB%A4%E7%89%8C%E5%8F%AF%E8%83%BD%E4%BC%9A%E5%AF%BC%E8%87%B4%E4%B8%8D%E5%BF%85%E8%A6%81%E7%9A%84GitHub%E9%80%9A%E7%9F%A5%E3%80%82

不同仓库类型所需的令牌权限如下：

环境变量

修改机器人行为

可在仓库根目录放置名为.vipgoci_options的配置文件来更改机器人行为。该文件必须包含有效的JSON字符串，否则将被忽略。可在此文件中添加代码以关闭支持消息或调整PHPCS严重级别。

例如，调整PHPCS严重级别：

json
{
  "phpcs-severity": 5
}

允许的选项：

• "skip-execution"
• "skip-draft-prs"
• "results-comments-sort"
• "review-comments-include-severity"
• "phpcs"
• "phpcs-severity"
• "post-generic-pr-support-comments"
• "phpcs-sniffs-include"
• "phpcs-sniffs-exclude"
• "hashes-api"
• "svg-checks"
• "autoapprove"
• "autoapprove-php-nonfunctional-changes

更多详情请查看https://github.com/automattic/vip-go-ci#configuration-via-repository-config-file%E3%80%82

跳过特定文件夹的PHPCS扫描

可在仓库根目录添加文件来指定不应扫描的文件夹。PHPCS对应的文件名为.vipgoci_phpcs_skip_folders，PHP Linting对应的文件名为.vipgoci_lint_skip_folders。确保这两个文件都位于仓库根目录。

这可作为SKIP_FOLDERS环境变量的替代方法。

请注意：PHPCS xml文件中排除的文件夹在此Action中不生效，原因详见https://github.com/rtCamp/action-phpcs-code-review/issues/29#issuecomment-623933663%E3%80%82%E5%BA%94%E5%B0%86%E6%89%80%E6%9C%89%E9%9C%80%E6%8E%92%E9%99%A4%E7%9A%84%E6%96%87%E4%BB%B6%E5%A4%B9%E6%B7%BB%E5%8A%A0%E5%88%B0%60SKIP_FOLDERS%60%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E6%88%96%60.vipgoci_phpcs_skip_folders%60%E6%96%87%E4%BB%B6%E4%B8%AD%E3%80%82

在这些文件中，每行列出一个需跳过的文件夹：

foo
tests/bar
vendor
node_modules

更多详情请查看https://github.com/automattic/vip-go-ci#skipping-certain-folders%E3%80%82

PHPCS编码标准

以下是运行时可用的PHPCS嗅探规则列表。可通过逗号分隔值同时传递多个标准。默认传递WordPress-Core,WordPress-Docs。

• MySource
• PEAR
• PHPCompatibility
• PHPCompatibilityParagonieRandomCompat
• PHPCompatibilityParagonieSodiumCompat
• PHPCompatibilityWP
• PSR1
• PSR12
• PSR2
• Squiz
• WordPress（默认）
• WordPress-Core（默认）
• WordPress-Docs（默认）
• WordPress-Extra
• WordPress-VIP
• WordPress-VIP-Go
• WordPressVIPMinimum
• Zend

自定义嗅探规则

默认支持的规则集文件名：

• .phpcs.xml
• phpcs.xml
• .phpcs.xml.dist
• phpcs.xml.dist

若仓库根目录存在phpcs.xml文件，则该文件优先，此时传递给args的值（如args: "WordPress,WordPress-Core,WordPress-Docs"）将被忽略。

若仓库没有phpcs.xml且未在工作流中指定args，则Action将回退到默认标准。

若仓库的PHPCS规则集文件不是默认文件名列表中的文件，可使用PHPCS_STANDARD_FILE_NAME环境变量指定文件名。

示例https://github.com/rtCamp/github-actions-wordpress-skeleton/blob/master/phpcs.xml%E5%8F%AF%E7%94%A8%E4%BA%8E%E8%87%AA%E5%AE%9A%E4%B9%89%E5%97%85%E6%8E%A2%E8%A7%84%E5%88%99%E3%80%82

自定义编码标准

若仓库中有自定义编码标准，可通过Composer安装并使用PHPCS_FILE_PATH环境变量指定仓库中的phpcs执行文件路径。

截图

自动化代码审查效果

限制

请注意：

1. 此Action仅对拉取请求运行，包括拉取请求创建后推送的新提交。
2. 此Action不审查添加此Action前仓库中已存在的代码。
3. 此Action不审查直接提交到分支的代码。强烈建议禁用直接提交到主分支。

许可证

MIT © 2019 rtCamp

感兴趣吗？