introduce api-extractor

2 files changed, 44 insertions, 0 deletions

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index afa1e2f1ff..8384cfadea 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -5,9 +5,11 @@ PRありがとうございます！ PRを作成する前に、以下をご確認
   - また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
 - このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
 - CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
+- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
 - 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
 - テスト、Lintが通っていることを予め確認してください。
   - `npm run test`、`npm run lint`でぞれぞれ実施可能です
+- `npm run api`を実行してAPIレポートを更新し、差分がある場合はコミットしてください。
 ご協力ありがとうございます🤗
 -->
 <!-- ℹ README
@@ -17,9 +19,11 @@ Thank you for your PR! Before creating a PR, please check the following:
   - Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
 - If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
 - Please add the summary of the changes to CHANGELOG.md. However, this is not necessary for changes that do not affect the users, such as refactoring.
+- Check if there are any documents that need to be created or updated due to this change.
 - If you have added a feature or fixed a bug, please add a test case if possible.
 - Please make sure that tests and Lint are passed in advance.
   - You can run it with `npm run test` and `npm run lint`.
+- Run `npm run api` to update the API report and commit it if there are any diffs.
 Thanks for your cooperation 🤗
 -->
 
diff --git a/.github/workflows/api.yml b/.github/workflows/api.yml
new file mode 100644
index 0000000000..89b7257ca5
--- /dev/null
+++ b/.github/workflows/api.yml
@@ -0,0 +1,40 @@
+name: API report
+
+on: [push, pull_request]
+
+jobs:
+  report:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.5.0
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Check files
+        run: ls built
+
+      - name: API report
+        run: npm run api-prod
+
+      - name: Show report
+        if: always()
+        run: cat temp/aiscript.api.md