この GitHub Action は変更が行われた datapack ドキュメントの静的解析を行います。

This GitHub Action performs a static analysis of the datapack document in which the changes were made.

1. GitHub の自身のリポジトリで Actions タブへ行き New workflow をクリック

   Go to your own repository on GitHub, go to the Actions tab and click on New workflow.

2. 下の方にある Manual workflow を選択し下記の設定ファイルをコピー & ペースト

   Select the Manual workflow at the bottom and copy and paste the following configuration file

3. 右上の Start commit -> Commit new file を押し準備完了

   Press Start commit -> Commit new file in the upper right corner to get ready.

   name: lint-datapack
   on:
     push:
     pull_request:
     workflow_dispatch:
   jobs:
     lint:
       name: lint
       runs-on: ubuntu-latest
       steps:
         - name: checkout repository
           uses: actions/checkout@v3
           with:
             fetch-depth: 0
   
         - name: lint
           uses: ChenCMD/datapack-linter@v2

datapack linterはDatapack Helper Plusに使用されている言語サーバーを使用しており、 リポジトリルートに配置された.vscode/setting.jsonを自動的に読み込み校閲ルールに適用します。

このファイルはVSCodeでワークスペースの設定を変更すると生成されます。

The datapack linter uses the same language server used by Datapack Helper Plus, and automatically reads .vscode/setting.json placed in the repository root and applies it to the review rules.

This file is generated when you change the workspace settings in VSCode.

注: ignoreLintPathPattern は複数の文字列を入れることが可能です。方法は下記のサンプルを参照してください。

note: ignoreLintPathPattern can contain multiple character strings. Please refer to the sample below for the method.

         - name: lint
           uses: ChenCMD/datapack-linter@v2
           with:
             ignoreLintPathPattern: |
               ignore:**
               example:ignore/**
               example:data/ignore/**

datapack linter はキャッシュを利用して、動作速度を高速にしています。
しかし、さまざまな要因で稀にキャッシュが破損する可能性があります。 その場合、コミットメッセージに [regenerate cache] という文字列を含めることでキャッシュを再生成することが可能です。

The datapack linter uses a cache to speed up its operation.
However, there is a rare possibility that the cache gets corrupted due to various reasons. In that case, you can regenerate the cache by including the string [regenerate cache] in the commit message.