Skip to content

Rename occurrences of CSK to Checkout Kit - #10

Merged
tiagocandido merged 1 commit into
mainfrom
05-05-rename_occurrences_of_csk_to_checkout_kit
May 6, 2026
Merged

tiagocandido merged 1 commit into
mainfrom
05-05-rename_occurrences_of_csk_to_checkout_kit

Conversation

@tiagocandido

@tiagocandido tiagocandido commented May 5, 2026 •

Copy link
Copy Markdown
Contributor

What changes are you making?

Renames the Android library from Shopify Checkout Sheet Kit to Shopify Checkout Kit as part of the broader cross-platform rebranding effort.

Package and artifact

  • Maven artifact: com.shopify:checkout-sheet-kit → com.shopify:checkout-kit
  • Android package/namespace: com.shopify.checkoutsheetkit → com.shopify.checkoutkit
  • Env var used to override the published version: CHECKOUT_SHEET_KIT_VERSION → CHECKOUT_KIT_VERSION

Source files and directories

  • lib/src/main/java/com/shopify/checkoutsheetkit/ → checkoutkit/
  • lib/src/test/java/com/shopify/checkoutsheetkit/ → checkoutkit/
  • ShopifyCheckoutSheetKit.kt → ShopifyCheckoutKit.kt
  • ShopifyCheckoutSheetKitTest.kt → ShopifyCheckoutKitTest.kt
  • checkout-sheet-kit.png → checkout-kit.png

Branding strings ("Checkout SDK" → "Checkout Kit")

  • Android resource IDs: checkoutSdkContainer, checkoutSdkHeader, checkoutSdkCloseBtn → checkoutKitContainer, checkoutKitHeader, checkoutKitCloseBtn
  • dialog_checkout.xml and checkout_menu.xml updated accordingly

Sample app

  • Package renamed: com.shopify.checkout_sdk_mobile_buy_integration_sample → com.shopify.checkout_kit_mobile_buy_integration_sample
  • CheckoutSdkApp.kt → CheckoutKitApp.kt
  • DataStore preferences key: "checkoutSheetKitSettingsV2" → "checkoutKitSettings" (V-suffix dropped as part of this clean break)

Not changed (cross-team web checkout contracts)

  • ShopifyCheckoutSDK in the user-agent string — parsed by the web checkout; requires web team coordination
  • window.MobileCheckoutSdk in the JS bridge — a global defined by the web checkout's JavaScript; renaming it unilaterally would silently break all bridge messages
  • checkout-sdk.myshopify.com test fixture URLs — not a branding reference

How to test

  1. Run the test suite — all 168 tests should pass:

    cd android
    ./gradlew clean test --console=plain
  2. Verify the public API surface is consistent with the rename:

    ./gradlew :lib:apiCheck

    If it fails after a clean build, regenerate with ./gradlew :lib:apiDump and review the diff.

  3. Build the sample app to confirm the renamed package compiles end-to-end:

    cd android/samples/MobileBuyIntegration
    cp .env.example .env  # fill in real values if needed
    ./gradlew assembleDebug
  4. Consumer migration check — any app importing the old library will need to:

    • Update Gradle dependency: com.shopify:checkout-sheet-kit → com.shopify:checkout-kit
    • Update all imports: com.shopify.checkoutsheetkit.* → com.shopify.checkoutkit.*
    • Update ProGuard rules: -keep class com.shopify.checkoutsheetkit.** → com.shopify.checkoutkit.**

Before you merge

Important

  • I've added tests to support my implementation
  • I have read and agree with the Contribution Guidelines
  • I have read and agree with the Code of Conduct
  • I've updated the relevant platform README (swift/README.md and/or android/README.md)

Releasing a new Swift version?
  • I have bumped the version in swift/ShopifyCheckoutSheetKit.podspec
  • I have bumped the version in swift/Sources/ShopifyCheckoutSheetKit/ShopifyCheckoutSheetKit.swift
  • I have updated swift/CHANGELOG.md
  • I have updated the SwiftPM/CocoaPods version snippets in swift/README.md (major version only)
Releasing a new Android version?
  • I have bumped the versionName in android/lib/build.gradle
  • I have updated android/CHANGELOG.md
  • I have updated the Gradle/Maven version snippets in android/README.md

Tip

See the Contributing documentation for the full release process per platform.

tiagocandido commented May 5, 2026 •

Copy link
Copy Markdown
Contributor Author

Base automatically changed from feat/monorepo-setup to main May 5, 2026 17:16
@tiagocandido
tiagocandido force-pushed the 05-05-rename_occurrences_of_csk_to_checkout_kit branch from c0aeafc to 04ed7d5 Compare May 5, 2026 18:05
Comment thread android/README.md Outdated
@tiagocandido
tiagocandido force-pushed the 05-05-rename_occurrences_of_csk_to_checkout_kit branch from 04ed7d5 to b07b867 Compare May 5, 2026 21:06
@tiagocandido
tiagocandido marked this pull request as ready for review May 5, 2026 21:08

@Juanita-Dash Juanita-Dash left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Review assisted by pair-review

Comment thread android/README.md Outdated
Comment thread android/README.md Outdated
Comment thread android/samples/MobileBuyIntegration/README.md Outdated
Comment thread android/dev.yml Outdated
@tiagocandido
tiagocandido force-pushed the 05-05-rename_occurrences_of_csk_to_checkout_kit branch 2 times, most recently from 745fbbd to e0c240c Compare May 6, 2026 15:46

@Juanita-Dash Juanita-Dash left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tiagocandido
tiagocandido requested a review from kiftio May 6, 2026 16:04
@tiagocandido
tiagocandido force-pushed the 05-05-rename_occurrences_of_csk_to_checkout_kit branch from f7708b8 to ed6b26f Compare May 6, 2026 17:30
@tiagocandido
tiagocandido merged commit 08e232a into main May 6, 2026
13 checks passed
@tiagocandido
tiagocandido deleted the 05-05-rename_occurrences_of_csk_to_checkout_kit branch May 6, 2026 17:53
Juanita-Dash referenced this pull request in Shopify/checkout-sheet-kit-react-native May 6, 2026
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash referenced this pull request in Shopify/checkout-sheet-kit-react-native May 6, 2026
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
kieran-osgood-shopify referenced this pull request in Shopify/checkout-sheet-kit-react-native May 6, 2026
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
kieran-osgood-shopify referenced this pull request in Shopify/checkout-sheet-kit-react-native May 6, 2026
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
kieran-osgood-shopify referenced this pull request in Shopify/checkout-sheet-kit-react-native May 6, 2026
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
kieran-osgood-shopify referenced this pull request in Shopify/checkout-sheet-kit-react-native May 6, 2026
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@markmur markmur added the #gsd:50662 Rebase Checkout Kit on UCP label May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

#gsd:50662 Rebase Checkout Kit on UCP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants