Run any Skill in Manus with one click

api-reports

Stars1

Forks1

UpdatedJune 18, 2026 at 21:22

Check or update the committed API reports for the @trycourier packages (API Extractor reports under api/*.api.md). Use when CI's "Build packages and check API changes" job fails on an API diff, when you intentionally changed a package's public API surface and need to refresh the committed report, or to verify locally that the reports are in sync before pushing.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

trycourier

trycourier/courier-web

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software Quality Assurance Analysts and TestersComputer and Mathematical Occupations·SOC 15-1253

SKILL.md

readonly

name	api-reports
description	Check or update the committed API reports for the @trycourier packages (API Extractor reports under api/*.api.md). Use when CI's "Build packages and check API changes" job fails on an API diff, when you intentionally changed a package's public API surface and need to refresh the committed report, or to verify locally that the reports are in sync before pushing.

Check & update the API reports

The public API surface of every @trycourier/* package is captured by API Extractor in a committed report at the repo root: api/<package>.api.md. CI fails if a package's built API no longer matches its committed report, so any intentional API change must ship with an updated report in the same PR.

How it works

Each package's api-extractor.json writes its report to the root api/ folder (apiReport.reportFolder: "../../api").
API Extractor reads the built types (dist/index.d.ts) — so the package must be built before the report is accurate.
api-extractor run (no flags) runs in check mode: read-only, exits non-zero if the report is stale. This is wired into each package's build:ci.
api-extractor run --local runs in update mode: rewrites api/<package>.api.md.

Check whether the reports are in sync (read-only)

This is exactly what CI runs — it builds every package and runs API Extractor in check mode:

yarn build-packages:ci

If it fails with an API report mismatch, the public API changed without the committed report being updated → go update it below.

Update the reports after an intentional API change

Rebuilds all packages and regenerates every report with --local:

yarn generate-api-docs

Then:

Review the diff: git diff api/ — confirm the changes match what you intended to expose/remove/rename. An unexpected entry usually means an accidental export or a forgotten release tag.
Commit the updated api/*.api.md files in the same PR as the source change.
If the diff is large or surprising, double-check it's not a side effect of an unintended public export.

Notes

Run from the repo root. Package manager is yarn@1 (classic).
Reports live at api/*.api.md; per-package config is each package's api-extractor.json. Scripts: scripts/generate-api-docs (update) and scripts/build-packages-ci (build + check, used by CI's build-packages.yml).
This skill lives at .agents/skills/api-reports/SKILL.md (the cross-tool Agent Skills standard path). Cursor and Codex discover it there natively; Claude Code discovers it via the .claude/skills → ../.agents/skills directory symlink.

More from this repository

same repository

changesets

trycourier/courier-web

Manage versioning for the @trycourier packages with changesets — create a changeset describing a version bump after changing package source, and bump package versions for release with `yarn changeset version`. Use when modifying @trycourier/*/src and a release-tracking changeset is needed, or when cutting a release locally / running the "Version Packages" step by hand.

2026-07-151

npm-release-pipeline

trycourier/courier-web

Diagnose and drive the courier-web npm release pipeline — the Release workflow on main, the changesets "Version Packages" PR (changelogs + version bumps), and OIDC publishing to npm. Use when a Release run fails, packages didn't appear on npm after merging Version Packages, publishing hits ENEEDAUTH, or someone asks why the changelogs/release didn't kick off after a merge.

2026-07-151

update-component-theme

trycourier/courier-web

Change or add a themable style (border, color, shadow, radius, font) on a Courier UI web component — inbox, toast, preferences, or core. Use when adjusting a component's default look, adding a new theme property, or fixing a style that doesn't render in light or dark mode.

2026-07-141

sync-examples

trycourier/courier-web

Keep the framework-SDK showcase example apps (react-latest, react-17, vue, and angular) at feature parity — the same set of demo pages and routes, one per SDK. Use whenever you add, change, or remove a demo in one showcase example (a new route/page, a themed variant, a custom-renderer demo, etc.) so the change is mirrored across the others, or when auditing that the showcases are in sync.

2026-06-181

add-example-app

trycourier/courier-web

Checklist for adding a new example app under examples/* so it's runnable and discoverable. Use whenever you create a new example app (any new examples/<name> workspace) — it MUST be registered in .vscode/launch.json's "🚀 Run Example App" picker, and there are a few other wiring steps. Apply this any time you scaffold a new example.

2026-06-181

run-example-app

trycourier/courier-web

Run one of the example apps' dev servers (the "🚀 Run Example App" launch config). Use when asked to start, run, preview, or manually test an example app (web-js, vue, next-latest, next-12, react-latest, react-17, designer), e.g. to see an inbox/toast/preferences change working in a browser.

2026-06-181

name	api-reports
description	Check or update the committed API reports for the @trycourier packages (API Extractor reports under api/*.api.md). Use when CI's "Build packages and check API changes" job fails on an API diff, when you intentionally changed a package's public API surface and need to refresh the committed report, or to verify locally that the reports are in sync before pushing.

Check & update the API reports

How it works

Each package's api-extractor.json writes its report to the root api/ folder (apiReport.reportFolder: "../../api").
API Extractor reads the built types (dist/index.d.ts) — so the package must be built before the report is accurate.
api-extractor run (no flags) runs in check mode: read-only, exits non-zero if the report is stale. This is wired into each package's build:ci.
api-extractor run --local runs in update mode: rewrites api/<package>.api.md.

Check whether the reports are in sync (read-only)

This is exactly what CI runs — it builds every package and runs API Extractor in check mode:

yarn build-packages:ci

If it fails with an API report mismatch, the public API changed without the committed report being updated → go update it below.

Update the reports after an intentional API change

Rebuilds all packages and regenerates every report with --local:

yarn generate-api-docs

Then:

Review the diff: git diff api/ — confirm the changes match what you intended to expose/remove/rename. An unexpected entry usually means an accidental export or a forgotten release tag.
Commit the updated api/*.api.md files in the same PR as the source change.
If the diff is large or surprising, double-check it's not a side effect of an unintended public export.

Notes

Run from the repo root. Package manager is yarn@1 (classic).
Reports live at api/*.api.md; per-package config is each package's api-extractor.json. Scripts: scripts/generate-api-docs (update) and scripts/build-packages-ci (build + check, used by CI's build-packages.yml).
This skill lives at .agents/skills/api-reports/SKILL.md (the cross-tool Agent Skills standard path). Cursor and Codex discover it there natively; Claude Code discovers it via the .claude/skills → ../.agents/skills directory symlink.