■ はじめに

https://dk521123.hatenablog.com/entry/2024/02/28/225002
https://dk521123.hatenablog.com/entry/2024/03/01/163922

で、SQL Linter を扱ったが
今回は、これらを、Github Actions で実行させる。

【１】ドキュメント

１）SQLFluff

https://docs.sqlfluff.com/en/stable/production.html

２）sqlfmt

https://docs.sqlfmt.com/integrations/github-actions

【２】サンプル

例１：SQLFluff での修正およびGithubコミット

.github/workflows/demo_linter.yml

name: Run SQL linter

on:
  workflow_dispatch:

jobs:
  sample-job:
    runs-on: ubuntu-latest
    steps:
      - name: Run checkout
        uses: actions/checkout@v4
      - name: Setup Python
        uses: 'actions/setup-python@v2' 
        with:
            python-version: '3.10'
      - name: install SQLFluff
        run: 'pip install sqlfluff'
      - name: format
        run: |
          for file in 'sqls/*.sql' 
          do
            sqlfluff fix $file --rules L001,L002,L003,L004,L005,L006,L010,L011,L012,L017,L018,L019,L022,L023 --dialect snowflake
          done
      # ★「【３】Tips」の「２）自動コミット」を参照
      - name: commit
        uses: stefanzweifel/git-auto-commit-action@v3.0.0
        with:
          commit_message: run sqlfluff

sql/test.sql

-- This is a test SQL.
                    SELECT
    * FROM    
    sample_table AS t1
;

[Github Workflow実行後] sql/test.sql

-- This is a test SQL.
SELECT
    * FROM
    sample_table AS t1
;

例２：sqlfmt でフォーマットチェック

run_demo_sqlfmt.yaml

name: Run SQL linter with sqlfmt

on:
  workflow_dispatch:

jobs:
  sample-job:
    runs-on: ubuntu-latest
    steps:
      - name: Run checkout
        uses: actions/checkout@v4
      - name: Setup Python
        uses: 'actions/setup-python@v2' 
        with:
            python-version: '3.10'
      - name: install sqlfmt
        run: "pip install 'shandy-sqlfmt[jinjafmt]'"
      - name: format
        run: |
          sqlfmt --diff sqls

【３】Tips

１）continue-on-error

* エラーでも処理を継続したい場合、
　「continue-on-error: true」を指定する
 => 詳細は、以下の関連記事を参照のこと

Github Actions ～エラー処理 / continue-on-error ～
https://dk521123.hatenablog.com/entry/2024/01/01/232057

２）自動コミット

* 以下の「stefanzweifel/git-auto-commit-actionアクション」で、
　変更したファイルを自動コミットできる

https://github.com/stefanzweifel/git-auto-commit-action
https://github.com/marketplace/actions/git-auto-commit

参考文献

https://qiita.com/k_0120/items/a25de096352c95dd70d6
https://techblog.kazaneya.com/20230417-sqlfluff-dummy-bigquery/

プログラムの超個人的なメモ

Memo for Programming.

【Github】Github Actions ～ SQL Linter ～

■ はじめに

目次

【１】ドキュメント

１）SQLFluff

２）sqlfmt

【２】サンプル

例１：SQLFluff での修正およびGithubコミット

例２：sqlfmt でフォーマットチェック

【３】Tips

１）continue-on-error

２）自動コミット

参考文献

関連記事