inngest / inngest-js

The developer platform for easily building reliable workflows with zero infrastructure for TypeScript & JavaScript
https://www.inngest.com/
GNU General Public License v3.0
440 stars 43 forks source link

Test for `composite: true` errors in CI, ensuring we can't ship those issues #501

Closed jpwilliams closed 8 months ago

jpwilliams commented 9 months ago

Summary

We've seen some issues crop up when composite: true is present in tsconfig.json files. This PR adds a composite: true project where we test the Inngest package for compliance for the types that it exports.

We purposefully want to limit the number of types exported from the main "inngest" entrypoint, as each type exported here becomes part of the public API, where changing those types is a breaking change. Therefore, the composite check gives us a (albeit inaccurate) test that can stop us shipping these dangerous changes.

Checklist

Related

changeset-bot[bot] commented 9 months ago

🦋 Changeset detected

Latest commit: 7ed04c158236d31b3ce6c247939286795379a59c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | ------- | ----- | | inngest | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

inngest-release-bot commented 9 months ago

A user has added the prerelease/inngest label, so this PR will be published to npm with the tag pr-501. It will be updated with the latest changes as you push commits to this PR.

You can install this prerelease version with:

npm install inngest@pr-501

The last release was built and published from 7ed04c158236d31b3ce6c247939286795379a59c.