action sqlcheck

Action-sqlcheck

PRが要求されたときにSQLCheckを使用してSQLクエリでアンチパターンを自動的に識別するGitHubアクションは、クエリでリスクが見つかった場合にPRにコメントします

使用法

pull_requestイベントタイプをサポートします。

入力

パラメーター	必須	デフォルト値	説明
post-comment	間違い	真実	それが本当ならPRにコメントを投稿してください
token	真実	""	PRにコメントを追加するためのgithubトークン
risk-level	間違い	3	チェックするSQLアンチパターンのセット：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 }}

sample2（ポストフィックスとディレクトリの入力）

.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