Test for composite: true errors in CI, ensuring we can't ship those issues
#501
Conversation
This file contains 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
jpwilliams
added
Bug
🦋 Changeset detectedLatest commit: 7ed04c1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
A user has added the prerelease/inngest label, so this PR will be published to npm with the tag You can install this prerelease version with: npm install inngest@pr-501The last release was built and published from 7ed04c1. |
djfarrelly
approved these changes
Feb 23, 2024
Comment on lines
+34
to
+35
| This code is only built and is never run, so don't worry about it actually | ||
| working. |
Merged
jpwilliams
pushed a commit
that referenced
this pull request
Feb 26, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## inngest@3.15.1 ### Patch Changes - [#501](#501) [`0048c94`](0048c94) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Fix failures for `composite: true` errors Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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.
Summary
We've seen some issues crop up when
composite: trueis present intsconfig.jsonfiles. This PR adds acomposite: trueproject 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
Added a docs PR that references this PRN/A Bug fix and testingRelated
composite#384compositesetting #385compositesetting #460