Added Branches support in entry variants#361
Draft
sunil-lakshman wants to merge 2 commits into
Draft
Conversation
🔒 Security Scan Results
⏱️ SLA Breach Summary
✅ BUILD PASSED - All security checks passed |
Coverage report
Test suite run success688 tests passing in 32 suites. Report generated by 🧪jest coverage report action from a0d7d72 |
…o support new changelog format
🔒 Security Scan Results
⏱️ SLA Breach Summary
✅ BUILD PASSED - All security checks passed |
harshitha-cstk
approved these changes
May 15, 2026
cs-raj
approved these changes
May 15, 2026
reeshika-h
approved these changes
May 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the Delivery SDK’s entry variant support to optionally include a branch name, allowing variant-scoped requests to also set the branch request header (while keeping existing variants(uid|uids) behavior backward compatible).
Changes:
- Added
buildVariantRequestHeaders()utility to centrally constructx-cs-variant-uidand optionalbranchheaders. - Updated
Entry,Entries,BaseQuery, andQueryrequest flows to attach variant+branch headers when configured. - Added/expanded unit tests and introduced an API test suite covering variant+branch behavior; bumped version + changelog and updated the version-bump workflow to parse the changelog format.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/utils.spec.ts | Adds unit coverage for buildVariantRequestHeaders(). |
| test/unit/entry.spec.ts | Adds unit coverage for Entry.variants(variant, branch) and fetch header behavior. |
| test/unit/entries.spec.ts | Adds unit coverage for Entries.variants(..., branch) and query().find() header behavior. |
| test/unit/base-query.spec.ts | Extends BaseQuery test harness to include variants branch and validates headers. |
| test/api/entry-variants-branch.spec.ts | New API test suite for entry/entries variant+branch behavior and chaining scenarios. |
| src/query/query.ts | Extends Query to carry variants branch state and apply headers during find(). |
| src/query/base-query.ts | Applies shared variant+branch header building in BaseQuery find(). |
| src/entries/entry.ts | Adds optional branch argument to Entry.variants() and applies headers during fetch(). |
| src/entries/entries.ts | Adds optional branch argument to Entries.variants(), propagates branch into query(), and applies headers during find(). |
| src/common/utils.ts | Introduces buildVariantRequestHeaders() helper. |
| package.json | Bumps SDK version to 5.3.0. |
| package-lock.json | Updates lockfile version metadata to 5.3.0. |
| CHANGELOG.md | Adds 5.3.0 entry documenting variant+branch support. |
| .github/workflows/check-version-bump.yml | Updates changelog parsing to support the current “### Version:” format. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
43
to
+47
| * @method variants | ||
| * @memberof Entry | ||
| * @description The variant header will be added to axios client | ||
| * @description The variant header will be added to axios client. Branch is optional. | ||
| * @param {string | string[]} variants - Variant UID or UIDs | ||
| * @param {string} [branchName] - Optional branch name sent as the `branch` header |
Comment on lines
264
to
+268
| * @method variants | ||
| * @memberof Entries | ||
| * @description The variant header will be added to axios client | ||
| * @description The variant header will be added to axios client. Branch is optional. | ||
| * @param {string | string[]} variants - Variant UID or UIDs | ||
| * @param {string} [branchName] - Optional branch name sent as the `branch` header |
Comment on lines
+10
to
+18
| constructor( | ||
| client: AxiosInstance, | ||
| params: params, | ||
| queryParams: queryParams, | ||
| variants?: string, | ||
| uid?: string, | ||
| variantsBranchOrQueryObj?: string | { [key: string]: any }, | ||
| queryObj?: { [key: string]: any } | ||
| ) { |
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.
No description provided.