From c1be599fe0e76dbe641488abb1866406e79828ff Mon Sep 17 00:00:00 2001 From: sevenc-nanashi Date: Thu, 28 Aug 2025 07:26:09 +0900 Subject: [PATCH 1/3] ci: check if docs/*.json is up-to-date --- .github/workflows/ci-update-check.yml | 38 +++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/ci-update-check.yml diff --git a/.github/workflows/ci-update-check.yml b/.github/workflows/ci-update-check.yml new file mode 100644 index 0000000000..2778137a62 --- /dev/null +++ b/.github/workflows/ci-update-check.yml @@ -0,0 +1,38 @@ +name: Checking if generated files are up to date + +on: + push: + branches: + - main + - dev-2.0 + pull_request: + branches: + - "*" + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - name: Use Node.js 20.x + uses: actions/setup-node@v1 + with: + node-version: 20.x + - name: Get node modules + run: npm ci + env: + CI: true + - name: Build documentation + run: npm docs + env: + CI: true + - name: Check Git status + run: | + if [[ -n $(git status --porcelain) ]]; then + echo "There are uncommitted changes in the generated files. Please run 'npm docs' and commit the changes." + git status + exit 1 + else + echo "All generated files are up to date." + fi From 9514c41f24f57bf0bbc56ed0c220d1368e0ecef4 Mon Sep 17 00:00:00 2001 From: sevenc-nanashi Date: Thu, 28 Aug 2025 07:28:36 +0900 Subject: [PATCH 2/3] chore: update docs data --- docs/parameterData.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/parameterData.json b/docs/parameterData.json index b99217ebe8..9d2c312077 100644 --- a/docs/parameterData.json +++ b/docs/parameterData.json @@ -4655,6 +4655,10 @@ }, "modify": { "overloads": [ + [ + "Function", + "Object?" + ], [ "Object?" ] From 5ddb85b750b2d6c7037c897a65c766feca85fccc Mon Sep 17 00:00:00 2001 From: sevenc-nanashi Date: Fri, 12 Sep 2025 13:15:08 +0900 Subject: [PATCH 3/3] fix: npm docs -> npm run docs --- .github/workflows/ci-update-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-update-check.yml b/.github/workflows/ci-update-check.yml index 2778137a62..47a911e22b 100644 --- a/.github/workflows/ci-update-check.yml +++ b/.github/workflows/ci-update-check.yml @@ -24,7 +24,7 @@ jobs: env: CI: true - name: Build documentation - run: npm docs + run: npm run docs env: CI: true - name: Check Git status