checkstyle github action

Checkstyle Github Action

Это действие выдвигает результаты от Checkstyle в качестве аннотаций Check Run.

Действие также может использоваться для любых других инструментов статического анализа, которые производят отчеты в формате XML Checkstyle. Сам отчет должен быть получен на бывшем этапе сборки, например, в сборке Maven.

Вход

path

Необходимый. Файл, каталог или шаблон подстановочного знака, который описывает, где найти отчеты. Несколько файлов могут быть обработаны с помощью выражения глобуса, например: '**/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 '

И не забудьте включить выход XML для плагина Maven:

< 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 Events Checkout refs/pull/:prNumber/merge вместо головы запроса на вытягивание. Из -за этого номера строк для сгенерированных нарушений могут не соответствовать фактическим номерам строк, на которые они отображаются на HEAD . Как есть, на самом деле нет разумного способа запустить это действие в коммите Merge по запросу на привлечение, потому что результат будет опубликован в неназванном рабочем процессе для невидимого невидимого коммита. Даже для событий 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

Создайте TypeScript и упакуйте его для распространения

$ npm run build && npm run package

Запустить тесты ✔

$ npm test

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

...