Merged
Conversation
- move build project step after version bump
docs(observable): 📝 add @SInCE annotations to observable helpers docs(promise): 📝 add @SInCE annotations to promise helpers docs(string): 📝 add @SInCE annotations to string helpers docs(type): 📝 add @SInCE annotations to type helpers docs(url): 📝 add @SInCE annotations to URL helpers docs(version): 📝 add @SInCE annotations to version helpers build: 📦 remove unused build steps and add website metadata generation
There was a problem hiding this comment.
Pull request overview
This PR updates the build pipeline to generate a new “website metadata” bundle per category (API docs, examples, and dependency licenses) under build/<category>/meta/, and annotates many helpers with @since tags so the generated metadata can expose version availability.
Changes:
- Replace per-category
api.json/examples.json/licenses.jsongeneration with a singlemeta/-based website metadata generator. - Add
@sincetags across many helpers for improved website/API documentation. - Adjust release workflow ordering so the build runs after the version bump.
Reviewed changes
Copilot reviewed 64 out of 64 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/build/index.ts | Switch build pipeline to call buildWebsiteMetadata instead of separate api/examples/licenses generators. |
| scripts/build/build-website-metadata.ts | Add a new generator that emits meta/api.json, meta/examples.json, and meta/licenses.json per category. |
| helpers/version/stripV.ts | Add @since tag. |
| helpers/version/satisfiesRange.ts | Add @since tag. |
| helpers/version/parse.ts | Add @since tags on interface/function docs. |
| helpers/version/increment.ts | Add @since tag. |
| helpers/version/compare.ts | Add @since tag. |
| helpers/url/withTrailingSlash.ts | Add @since tags across overload docblocks. |
| helpers/url/withoutTrailingSlash.ts | Add @since tags across overload docblocks. |
| helpers/url/withoutLeadingSlash.ts | Add @since tags across overload docblocks. |
| helpers/url/withLeadingSlash.ts | Add @since tags across overload docblocks. |
| helpers/url/relativeURLToAbsolute.ts | Add missing JSDoc (incl. @since). |
| helpers/url/onlyPath.ts | Add @since tags across overload docblocks. |
| helpers/url/extractPureURI.ts | Add @since tag. |
| helpers/url/cleanPath.ts | Add @since tag. |
| helpers/type/typeChecks.ts | Add @since tags for exported type/functions. |
| helpers/type/isSpecialObject.ts | Add @since tag. |
| helpers/type/isEmpty.ts | Add @since tag. |
| helpers/string/slugify.ts | Add @since tag. |
| helpers/string/labelize.ts | Add @since tag. |
| helpers/string/kebabCase.ts | Add @since tag. |
| helpers/string/errorToReadableMessage.ts | Add @since tags across overload docblocks. |
| helpers/string/capitalize.ts | Add @since tag. |
| helpers/string/camelCase.ts | Add @since tag. |
| helpers/promise/truthyPromiseOrThrow.ts | Add @since (currently placed in a license block comment). |
| helpers/promise/retry.ts | Add @since tag. |
| helpers/promise/meaningPromiseOrThrow.ts | Add @since (currently placed in a license block comment). |
| helpers/promise/falsyPromiseOrThrow.ts | Add @since (currently placed in a license block comment). |
| helpers/promise/delay.ts | Add @since tag. |
| helpers/promise/consoleLogPromise.ts | Add @since (currently placed in a license block comment). |
| helpers/observable/combineLatest.ts | Add @since tag. |
| helpers/observable/combine.ts | Add @since tag. |
| helpers/object/set.ts | Add @since tag. |
| helpers/object/removeUndefinedNull.ts | Add @since tags across overload docblocks. |
| helpers/object/quickCompare.ts | Add @since tag. |
| helpers/object/get.ts | Add @since tag. |
| helpers/object/deepMerge.ts | Add @since tag. |
| helpers/object/deepCompare.ts | Add @since tags for exported interface/function. |
| helpers/object/deepClone.ts | Add @since tag. |
| helpers/number/roundTo.ts | Add @since tag. |
| helpers/number/random.ts | Add @since tags. |
| helpers/number/clamp.ts | Add @since tag. |
| helpers/function/throttle.ts | Add @since tag. |
| helpers/function/returnOrThrowError.ts | Add @since tag. |
| helpers/function/memoize.ts | Add @since tag. |
| helpers/function/isDefinedAndNotNull.ts | Add @since tag. |
| helpers/function/debounce.ts | Add @since tag. |
| helpers/date/timestamp.ts | Add @since tags. |
| helpers/date/safeDate.ts | Add @since tags. |
| helpers/date/is.ts | Add @since tag. |
| helpers/date/format.ts | Add @since tags. |
| helpers/date/difference.ts | Add @since tag. |
| helpers/date/compare.ts | Add @since tags for exported interface/function. |
| helpers/array/unique.ts | Add @since tag. |
| helpers/array/sort.ts | Add @since tags for exported types/constants/functions. |
| helpers/array/quickCompare.ts | Add @since tag. |
| helpers/array/oneInCommon.ts | Add @since tag. |
| helpers/array/intersection.ts | Add @since tag. |
| helpers/array/difference.ts | Add @since tag. |
| helpers/array/deepCompare.ts | Add @since tag. |
| helpers/array/chunk.ts | Add @since tag. |
| helpers/array/arrayEquals.ts | Add @since tag. |
| .template/category/package.json | Move exported JSON artifacts under ./meta/* and include meta/ in published files. |
| .github/workflows/release.yml | Run build after version bump in release workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
✅ PR Validation Passed
📋 Pipeline Status
📊 Code Coverage
🧬 Mutation Testing
ℹ️ About this report
🤖 Generated by @helpers4 CI • 2026-04-07 |
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
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.
Description
Please include a summary of what this PR does and why it's needed.
Type of Change
Related Issues
Closes #(issue number)
How Has This Been Tested?
Describe the tests you ran and how to reproduce them:
Checklist
Screenshots (if applicable)
Add screenshots for UI changes.
Additional Context
Add any other context about the PR here.