checkstyle github action

CheckStyle GitHub动作

此操作将CheckStyle的结果作为检查运行注释。

该操作还可以用于以CheckStyle XML格式生成报告的任何其他静态分析工具。该报告本身必须在以前的构建步骤中生成，例如Maven构建。

输入

path

必需的。文件，目录或通配符模式，可描述在哪里找到报告。可以通过Glob表达式处理多个文件，例如： '**/checkstyle.xml' 。

name

选修的。运行支票的名称要创建。默认为Checkstyle 。

title

选修的。支票运行的标题要创建。默认为Checkstyle Source Code Analyzer report 。

token

选修的。 github api访问令牌。默认为${{ github.token }} ，该}是由actions/checkout@v2最小化设置的。

示例用法

 name : Java CI

on : [push]

jobs :
  build :
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
    - name : Set up JDK 1.8
      uses : actions/setup-java@v1
      with :
        java-version : 1.8
    - uses : actions/cache@v1
      with :
        path : ~/.m2/repository
        key : ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
        restore-keys : |
          ${{ runner.os }}-maven-
    - name : Build with Maven
      run : mvn -B verify checkstyle:checkstyle
    - uses : jwgmeligmeyling/checkstyle-github-action@master
      with :
        path : ' **/checkstyle-result.xml '

并且不要忘记为Maven插件启用XML输出：

< build >
  < plugins >
    < plugin >
      < groupId >org.apache.maven.plugins</ groupId >
      < artifactId >maven-checkstyle-plugin</ artifactId >
      < version >3.1.1</ version >
      < configuration >
        < failsOnError >false</ failsOnError >
      </ configuration >
    </ plugin >
  </ plugins >
</ build >

请注意，默认情况下， pull_request事件上的工作流结帐refs/pull/:prNumber/merge而不是拉请求的头部。因此，生成的违规行为的行号可能与它们在HEAD上显示的实际线号不符。实际上，实际上并没有一种明智的方法可以在拉动请求的合并提交中运行此操作，因为结果将发布到未命名的工作流程中，以进行原本隐形的提交。即使对于pull_request事件，也有可能检查拉申请头。为此，请相应地更改您的checkout行动：

- uses : actions/checkout@v2
  with :
    ref : ${{ github.event.pull_request.head.sha }} 

其他相关行动

这是一系列其他GitHub动作中的GitHub动作。类似的行动包括：

• checkstyle-github-action
• pmd-github-action
• spotbugs-github-action

已知限制

由于GitHub API的限制，我们无法指定应关联新创建的检查运行的工作流程运行（或基础检查套件）。结果，触发几种类型的事件的工作流程可能会在另一个事件下推动结果，而不是进行操作。有关更多信息，请参见：＃2

贡献

安装依赖项

$ npm install

构建打字稿并打包以进行分发

$ npm run build && npm run package

运行测试✔️

$ npm test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)

...