Feat: release id [EXT-6547] #2287
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
lewisjcs
force-pushed
the
feat/releaseId-EXT-6547
branch
from
5d89a9d to
d62e235
Compare
lib/api.ts
Outdated
| @@ -64,6 +64,8 @@ function makeSharedAPI( | |||
| const { user, parameters, locales, ids, initialContentTypes, hostnames, release } = data | |||
| const currentLocation = data.location || locations.LOCATION_ENTRY_FIELD | |||
|
|
|||
| const idsWithRelease = release ? { ...ids, release: release.sys.id } : ids | |||
There was a problem hiding this comment.
Suggested change
| const idsWithRelease = release ? { ...ids, release: release.sys.id } : ids | |
| const maybeIdsWithRelease = release ? { ...ids, release: release.sys.id } : ids |
lib/api.ts
Outdated
| @@ -89,7 +91,7 @@ function makeSharedAPI( | |||
| error: (message: string) => channel.send('notify', { type: 'error', message }), | |||
| warning: (message: string) => channel.send('notify', { type: 'warning', message }), | |||
| }, | |||
| ids, | |||
| ids: idsWithRelease, | |||
There was a problem hiding this comment.
Suggested change
| ids: idsWithRelease, | |
| ids: maybeIdsWithRelease, |
lib/cma.ts
Outdated
| @@ -13,6 +13,8 @@ export function createCMAClient(ids: IdsAPI, channel: Channel): CMAClient { | |||
| environmentId: ids.environmentAlias ?? ids.environment, | |||
| spaceId: ids.space, | |||
| organizationId: ids.organization, | |||
| // TODO: Shipped in the CMA | |||
There was a problem hiding this comment.
I think this is a public repo, we might want to remove this TODO
BobHemphill76
requested changes
Jul 17, 2025
tylerwashington888
approved these changes
Jul 17, 2025
tylerwashington888
approved these changes
Jul 17, 2025
tylerwashington888
previously approved these changes
Jul 17, 2025
jsdalton
reviewed
Jul 17, 2025
lib/api.ts
Outdated
| @@ -64,6 +64,8 @@ function makeSharedAPI( | |||
| const { user, parameters, locales, ids, initialContentTypes, hostnames, release } = data | |||
| const currentLocation = data.location || locations.LOCATION_ENTRY_FIELD | |||
|
|
|||
| const effectiveIds = release ? { ...ids, release: release.sys.id } : ids | |||
There was a problem hiding this comment.
I'm not against this approach per se -- but I wonder why we append the releaseId here in the SDK instead of doing so upstream ie in the channel sender that provides the data attribute (where the other ids are).
lewisjcs
force-pushed
the
feat/releaseId-EXT-6547
branch
from
406df46 to
6905ba0
Compare
…reateCMAClient to include releaseId in the configuration
…akeSharedAPI function
…eIds and enforcing release property in IdsAPI
lewisjcs
force-pushed
the
feat/releaseId-EXT-6547
branch
from
6905ba0 to
4b0cdf7
Compare
BobHemphill76
approved these changes
Jul 21, 2025
|
🎉 This PR is included in version 4.34.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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.
Purpose of PR
This pull request enhances the
ui-extensions-sdkto support the "Releases v2" project by ensuring apps are aware of the release context they are operating in. This change specifically addresses ticket EXT-6547.We are adding the
releaseIdto thesdk.idsobject when an application is running within a release. This provides developers with a straightforward way to access the current release's ID, enabling them to build release-aware features.A primary use case for this is to allow an app to fetch data or modify its behavior based on the specific release it's interacting with. This is a foundational requirement for many of the planned features in Releases v2.
PR Checklist