action sqlcheck

Action-Sqlcheck

Действия GitHub, которые автоматически идентифицируют анти-паттерны в запросах SQL с использованием SQLCheck, когда просят PR, и прокомментируйте PR, если риски обнаруживаются в запросах

Использование

Поддерживает тип события pull_request .

Входные данные

Параметр	Необходимый	Значение по умолчанию	Описание
post-comment	ЛОЖЬ	истинный	Разместите комментарий к PR, если это правда
token	истинный	""	Токен GitHub, чтобы добавить комментарий к PR
risk-level	ЛОЖЬ	3	Набор SQL Anti-Patterns для проверки: 1,2 или 3 - 1 (все анти-паттерны, по умолчанию) - 2 (только средний и высокий риск анти-паттернов) - 3 (только анти-паттерны с высоким риском)
verbose	ЛОЖЬ	ЛОЖЬ	Добавить многословные предупреждения в результат анализа SQLCHECK
postfixes	ЛОЖЬ	"SQL"	Список файла postfix в соответствии с. Поддерживаемые сепараторы-это запятая (истекает) и перезапущение в многострочной строке
directories	ЛОЖЬ	""	Путь (ы) каталога, по которым действие проверяет любые файлы, являются ли они частью репозитория или нет. По умолчанию действие проверяет только файлы в PR -запросах. Определяя каталоги, действие больше не проверяет файлы в PR -запросах, а файлы в соответствии с каталогами (MaxDepth 3). Поддерживаемый сепаратор возвращается в многострочной строке

Выходы

Параметр	Описание
issue-found	Логическое значение для указания, что проблема была обнаружена в файлах, которые проверило действие SQLCheck

Образец рабочий процесс

Образец1

.github/Workflows/test1.yml

 name : sqlcheck workflow1
on : pull_request

jobs :
  sqlcheck :
    name : sqlcheck job
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@master
    - uses : yokawasa/[email protected]
      with :
        post-comment : true
        risk-level : 3
        verbose : false
        token : ${{ secrets.GITHUB_TOKEN }}

Образец2 (постфиксы и входные данные каталогов)

.github/Workflows/test2.yml

 name : sqlcheck workflow2
on : pull_request

jobs :
  sqlcheck :
    name : sqlcheck job
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@master
    - uses : yokawasa/[email protected]
      id : sqlcheck
      with :
        post-comment : true
        risk-level : 3
        verbose : true
        token : ${{ secrets.GITHUB_TOKEN }}
        postfixes : |
          sql
          sqlx
          schema
        directories : |
          sql
          build/sql_dir
          tests/sql_dir
    - name : Get output
      run : echo "Issues found in previous step"
      if : steps.sqlcheck.outputs.issue-found