Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: CI

on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

jobs:
verify:
name: Build & Verify API Surface
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v3
with:
version: 10.34.1

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 25.9.4
cache: 'pnpm'

- name: Install Dependencies
run: pnpm install --frozen-lockfile

- name: Run Build
run: pnpm build

- name: Verify Public API Report
run: pnpm api-report:ci
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,14 @@ pnpm build # Build must succeed

- GitHub Issues: preferred for all task discussion
- Contact: cerealboxx123@gmail.com

---

## Public API Changes

We monitor changes to our public API surface closely to prevent accidental breaking changes.

If you modify exported classes, interfaces, or types:
1. Run `pnpm api-report` locally to update the API baseline file (`api-report/guildpass-sdk.api.md`).
2. Commit the updated `guildpass-sdk.api.md` file alongside your code changes.
3. Your pull request will display a diff of the API changes for maintainer review.
38 changes: 38 additions & 0 deletions api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
"apiReport": {
"enabled": true,
"reportFolder": "<projectFolder>/api-report/",
"reportFileName": "guildpass-sdk.api.md"
},
"docModel": {
"enabled": false
},
"dtsRollup": {
"enabled": false
},
"tsdocMetadata": {
"enabled": false
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "warning"
},
"ae-missing-release-tag": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
}
}
}
Loading