[PR #7702] [CLOSED] chore: add api-extractor for type signature tracking in CI #7501

Closed
opened 2026-03-13 13:39:20 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/7702
Author: @bytaesu
Created: 1/30/2026
Status: Closed

Base: canaryHead: 2026-01-30/chore/api-signature-check


📝 Commits (2)

  • 031d42b chore: add api-extractor for type signature tracking in CI
  • a6e1d4a add remarkignore

📊 Changes

8 files changed (+1063 additions, -3 deletions)

View changed files

📝 .github/workflows/ci.yml (+3 -0)
📝 .remarkignore (+2 -0)
📝 package.json (+5 -2)
packages/core/api-extractor.api.md (+755 -0)
packages/core/api-extractor.json (+36 -0)
📝 packages/core/package.json (+3 -1)
📝 pnpm-lock.yaml (+249 -0)
📝 turbo.json (+10 -0)

📄 Description

Note

Adding this to catch important type changes in core packages.
reference: https://github.com/cloudflare/workers-sdk/blob/main/packages/miniflare/scripts/types.mjs#L85


Summary by cubic

Add API Extractor to track and gate public type signature changes for @better-auth/core. CI now fails if the exported API changes without updating the report.

  • Dependencies

    • Added @microsoft/api-extractor and config for packages/core.
    • New API report file: packages/core/api-extractor.api.md.
    • CI runs pnpm api-extractor:check; turbo tasks added for check/update.
  • Migration

    • When intentionally changing exported types, run: pnpm build && pnpm api-extractor:update.
    • Commit the updated packages/core/api-extractor.api.md.

Written for commit a6e1d4a04d. Summary will update on new commits.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/7702 **Author:** [@bytaesu](https://github.com/bytaesu) **Created:** 1/30/2026 **Status:** ❌ Closed **Base:** `canary` ← **Head:** `2026-01-30/chore/api-signature-check` --- ### 📝 Commits (2) - [`031d42b`](https://github.com/better-auth/better-auth/commit/031d42b1bf2aec37c1a5a4b8ec3cf92c3906a85e) chore: add api-extractor for type signature tracking in CI - [`a6e1d4a`](https://github.com/better-auth/better-auth/commit/a6e1d4a04d650b130e0d0a9b80d2dff5a7acd9af) add remarkignore ### 📊 Changes **8 files changed** (+1063 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/ci.yml` (+3 -0) 📝 `.remarkignore` (+2 -0) 📝 `package.json` (+5 -2) ➕ `packages/core/api-extractor.api.md` (+755 -0) ➕ `packages/core/api-extractor.json` (+36 -0) 📝 `packages/core/package.json` (+3 -1) 📝 `pnpm-lock.yaml` (+249 -0) 📝 `turbo.json` (+10 -0) </details> ### 📄 Description > [!NOTE] > Adding this to catch important type changes in core packages. > reference: https://github.com/cloudflare/workers-sdk/blob/main/packages/miniflare/scripts/types.mjs#L85 <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Add API Extractor to track and gate public type signature changes for @better-auth/core. CI now fails if the exported API changes without updating the report. - **Dependencies** - Added @microsoft/api-extractor and config for packages/core. - New API report file: packages/core/api-extractor.api.md. - CI runs pnpm api-extractor:check; turbo tasks added for check/update. - **Migration** - When intentionally changing exported types, run: pnpm build && pnpm api-extractor:update. - Commit the updated packages/core/api-extractor.api.md. <sup>Written for commit a6e1d4a04d650b130e0d0a9b80d2dff5a7acd9af. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-03-13 13:39:20 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#7501