如何在Checkstyle GitHub Action中自定义checkstyle.xml规则？

我们在Java代码库部署了Checkstyle GitHub Action（使用的是efeozsoy/checkstyle-java-commenter），但不知道怎么自定义规则。当前的Action配置YML如下：

on: pull_request 
jobs:
  checkstyle_job:
    runs-on: ubuntu-latest
    name: Checkstyle job
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run check style
        uses: efeozsoy/checkstyle-java-commenter@0.1.2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: 'github-pr-check'
          tool_name: 'checkstyle-java'

目前默认规则输出的结果中，我们需要修改最大行数和缩进规则，具体实现步骤如下：

1. 编写自定义Checkstyle配置文件 #

在项目根目录创建（或修改）checkstyle.xml文件，配置需要调整的规则。以下是针对最大行数和缩进的示例配置：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <!-- 自定义最大行长度，这里设为120 -->
        <module name="LineLength">
            <property name="max" value="120"/>
            <!-- 忽略特定行的长度检查，比如包声明、导入语句等 -->
            <property name="ignorePattern" value="^package.*|^import.*"/>
        </module>
        <!-- 自定义缩进规则，基础缩进设为4个空格 -->
        <module name="Indentation">
            <property name="basicOffset" value="4"/>
            <property name="caseIndent" value="4"/>
            <property name="braceAdjustment" value="0"/>
        </module>
    </module>
</module>

你可以根据实际需求调整value里的数值，比如把最大行长度改成150，缩进改成2个空格等。

2. 修改GitHub Action配置 #

在原YML配置中添加config_path参数，指定我们刚写的自定义配置文件路径。修改后的完整配置如下：

on: pull_request 
jobs:
  checkstyle_job:
    runs-on: ubuntu-latest
    name: Checkstyle job
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run check style
        uses: efeozsoy/checkstyle-java-commenter@0.1.2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: 'github-pr-check'
          tool_name: 'checkstyle-java'
          config_path: './checkstyle.xml' # 指定自定义配置文件的路径

3. 验证配置 #

把修改后的checkstyle.xml和Action配置文件提交到仓库，触发Pull Request时，Checkstyle Action就会使用我们自定义的规则进行代码检查了。

内容的提问来源于stack exchange，提问作者Efe