Feature/sdk publish workflow #299
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add publish-sdk.yml workflow that triggers on changes to src/api/** - Add API types in src/api/index.ts with full JSDoc documentation - Add tsconfig.api.json for building type declarations - Add build:api script to package.json - Update README with SDK installation instructions - Workflow automatically syncs types to commonknowledge/ts-mapped-sdk on push to main
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces an automated TypeScript SDK publishing workflow to distribute type definitions for the ts-mapped REST API. The SDK provides type-safe interfaces for external consumers to interact with the GeoJSON API endpoint.
Changes:
- Adds automated GitHub Actions workflow to build and publish TypeScript types to a separate SDK repository
- Creates comprehensive type definitions and documentation for the public API
- Adds TypeScript build configuration for generating declaration files
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/publish-sdk.yml |
Automates building, versioning, and publishing SDK to separate repository |
src/api/index.ts |
Defines public TypeScript interfaces for GeoJSON API, filters, and query parameters |
src/api/README.md |
Comprehensive usage guide with examples for SDK consumers |
tsconfig.api.json |
TypeScript configuration for generating declaration files only |
package.json |
Adds build:api script to generate type declarations |
README.md |
Documents SDK installation and usage for API consumers |
.gitignore |
Excludes generated dist directory from version control |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…query construction
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a TypeScript SDK publishing workflow and formalizes the public API types for external consumption. It adds a new GitHub Actions workflow to automate building and syncing TypeScript types to a separate SDK repository, documents the SDK in the main README, and creates a dedicated build configuration for API types. The most important changes are grouped below:
SDK Publishing Automation:
.github/workflows/publish-sdk.yml) that builds API types, prepares the SDK package, generates documentation, bumps the version, and pushes updates to thets-mapped-sdkrepository.Public API Types:
src/api/index.tsfor external consumers, including types for GeoJSON API responses, filters, and geocoding results.Build and Packaging:
build:apito generate type declarations using a dedicated TypeScript config.tsconfig.api.jsonto control the emission of declaration files for the SDK.Documentation:
README.mdto include installation and usage instructions for the new TypeScript SDK, referencing the new package and types.