Regenerate checkout docs JSON for 2025-07

.changeset/checkbox-rich-label.md

@@ -0,0 +1,5 @@
+---
+'@shopify/ui-extensions': patch
+---
+
+The `label` prop on the checkout and customer-account `s-checkbox` component now accepts a label as a slot in addition to a plain string, label slots can include only plain text and s-links.

.eslintrc.js

@@ -3,7 +3,6 @@ module.exports = {
     'plugin:@shopify/typescript',
     'plugin:@shopify/jest',
     'plugin:@shopify/prettier',
-    'plugin:@shopify/react',
   ],
   ignorePatterns: [
     'build/',
@@ -17,14 +16,19 @@ module.exports = {
     'packages/*/*.mjs',
     'packages/*/*.node',
     'packages/*/*.esnext',
+    'packages/ui-extensions/src/surfaces/checkout/**/*.d.ts',
+    'packages/ui-extensions/src/surfaces/checkout/preact/tests/',
+    'packages/ui-extensions/src/surfaces/point-of-sale/**/*.d.ts',
   ],
   rules: {
     // Codebase was originally written without some strict Shopify conventions
     'import/order': 'off',
+    'line-comment-position': 'off',
     '@typescript-eslint/naming-convention': 'off',
 
     // This rule is just bad
     '@typescript-eslint/consistent-indexed-object-style': 'off',
+    'eslint-comments/no-unused-disables': 'off',
   },
   overrides: [
     {
@@ -44,28 +48,13 @@ module.exports = {
         '@shopify/jsx-no-hardcoded-content': 'off',
       },
     },
-    {
-      files: ['packages/ui-extensions-react/src/surfaces/*/hooks/**'],
-      rules: {
-        // This is necessary because https://github.com/Shopify/generate-docs
-        // cannot yet infer return types.
-        '@typescript-eslint/explicit-function-return-type': 'error',
-      },
-    },
-    {
-      files: ['packages/ui-extensions-react/src/surfaces/*/hooks/tests/**'],
-      rules: {
-        '@typescript-eslint/explicit-function-return-type': 'off',
-      },
-    },
     {
       files: [
         'packages/ui-extensions/docs/surfaces/**/*.example.*',
         'packages/ui-extensions/src/surfaces/**/*.example.*',
       ],
       rules: {
         'no-console': 'off',
-        'react/react-in-jsx-scope': 'off',
         '@shopify/checkout-web/custom-error-subclassing': 'off',
         'import/no-extraneous-dependencies': 'off',
         'promise/catch-or-return': 'off',

.github/ISSUE_TEMPLATE/feature-request.md

@@ -4,9 +4,9 @@ about: Suggest an idea for this project
 labels: 'enhancement'
 ---
 
-## Please list the related package(s)
+## Please list the related surfaces(s)
 
-<!-- e.g. checkout-ui-extensions, admin-ui-extensions-react -->
+<!-- e.g. @shopify/ui-extensions/checkout -->
 
 ## If this related to specific APIs or components, please list them here
 

.github/ISSUE_TEMPLATE/issue-report.md

@@ -6,9 +6,9 @@ labels: 'bug'
 
 <!-- For feature requests, please use the following template: https://github.com/Shopify/ui-extensions/issues/new?labels=enhancement&template=feature-request.md -->
 
-## Please list the package(s) involved in the issue, and include the version you are using
+## Please list the surfaces(s) involved in the issue, and include the version you are using
 
-<!-- e.g. checkout-ui-extensions V0.10.1, admin-ui-extensions-react V0.11.0 -->
+<!-- e.g. @shopify/ui-extensions/checkout V0.10.1, @shopify/ui-extensions/admin V0.11.0 -->
 
 ## Describe the bug
 

.github/workflows/actions/prepare/action.yml

@@ -2,11 +2,12 @@ name: Prepare repo
 runs:
   using: 'composite'
   steps:
-    - uses: actions/setup-node@v3
+    - uses: actions/setup-node@v4
       name: Setup node.js and yarn
       with:
+        registry-url: 'https://registry.npmjs.org' # Required for OIDC
         cache: yarn
-        node-version-file: '.nvmrc'
+        node-version-file: '.nvmrc' # Must be 20+ to support npm 11.5.1+
 
     - name: Yarn install
       run: yarn install --frozen-lockfile

.github/workflows/ci.yml

@@ -6,12 +6,12 @@ jobs:
   type-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/workflows/actions/prepare
 
       - id: typescript-cache
         name: Restore TypeScript cache
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: |
             packages/*/build/ts
@@ -23,34 +23,16 @@ jobs:
       - name: Type check
         run: yarn type-check
 
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: ./.github/workflows/actions/prepare
-
-      - id: jest-cache
-        name: Restore jest cache
-        uses: actions/cache@v1
-        with:
-          path: .loom/cache/jest/
-          key: ${{ runner.os }}-jest-v1-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-jest-v1-
-
-      - name: Test
-        run: yarn test
-
   lint:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/workflows/actions/prepare
 
       - id: eslint-cache
         name: Restore ESLint cache
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: .loom/cache/eslint
           key: ${{ runner.os }}-eslint-v1-${{ github.sha }}
@@ -64,7 +46,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/workflows/actions/prepare
 
       - id: test-build

.github/workflows/deploy.yml

@@ -3,6 +3,7 @@ name: Deploy
 on:
   push:
     branches:
+      # Stable version branches
       - 2023-04
       - 2023-07
       - 2023-10
@@ -11,39 +12,82 @@ on:
       - 2024-07
       - 2024-10
       - 20[0-9][0-9]-[01][1470]
+      # RC version branches
+      - 20[0-9][0-9]-[01][1470]-rc
+  # Snapit trigger - runs when /snapit comment is made on a PR
+  issue_comment:
+    types:
+      - created
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
+  # Snapit job - runs when /snapit comment is made on a PR
+  snapit:
+    name: Snapit
+    if: ${{ github.event_name == 'issue_comment' && github.event.issue.pull_request && github.event.comment.body == '/snapit' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      id-token: write
+    steps:
+      # WARNING: DO NOT RUN ANY CUSTOM LOCAL SCRIPT BEFORE RUNNING THE SNAPIT ACTION
+      # This action can be executed by 3rd party users and it should not be able to run arbitrary code from a PR.
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.SHOPIFY_GH_ACCESS_TOKEN }}
+
+      - uses: ./.github/workflows/actions/prepare
+
+      - name: Update npm to 11.7
+        run: npm install -g npm@11.7
+
+      - name: Create snapshot
+        uses: Shopify/snapit@v0.1.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.SHOPIFY_GH_ACCESS_TOKEN }}
+          NPM_TOKEN: ''
+          NPM_CONFIG_PROVENANCE: true
+        with:
+          build_script: yarn build
+          comment_command: /snapit
+
   changesets:
     name: Deploy
+    if: ${{ github.event_name == 'push' }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write # Required for OIDC
     steps:
       - uses: actions/checkout@v3
         with:
           token: ${{ secrets.SHOPIFY_GH_ACCESS_TOKEN }}
 
       - uses: ./.github/workflows/actions/prepare
 
+      - name: Update npm to 11.7
+        run: npm install -g npm@11.7
+
       - id: changesets
         name: Create release Pull Request or publish to NPM
-        uses: changesets/action@v1
+        uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba # v1.5.3
         with:
           title: Version Packages (${{ github.ref_name }})
-          publish: yarn run deploy --tag ${{ github.ref_name }}
+          publish: yarn run deploy ${{ !endsWith(github.ref_name, '-rc') && format('--tag {0}', github.ref_name) || '' }} # no tag for RC branches.
+          createGithubReleases: false
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: '' # Forces OIDC authentication
           GITHUB_TOKEN: ${{ secrets.SHOPIFY_GH_ACCESS_TOKEN }}
 
+      # Known to fail in OIDC (https://github.com/npm/cli/issues/8547).
+      # Workaround is to manually ask #help-eng-infrastructure to update `latest` tag.
       - name: Set 'latest' NPM dist tag
         if: steps.changesets.outputs.published == 'true' && github.ref_name == vars.LATEST_STABLE_VERSION
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           PUBLISHED_PACKAGES: ${{ steps.changesets.outputs.publishedPackages }}
         run: |
-          cat << EOF > "$HOME/.npmrc"
-            //registry.npmjs.org/:_authToken=$NPM_TOKEN
-          EOF
           for pkg in $(echo "$PUBLISHED_PACKAGES" | jq -r '.[] | @base64'); do
             _jq() {
               echo ${pkg} | base64 --decode | jq -r ${1}

.github/workflows/mdx-migration-notice.yml

@@ -0,0 +1,52 @@
+name: MDX migration notice
+
+on:
+  pull_request_target:
+    types: [opened]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  notify:
+    name: MDX migration notice
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    if: ${{ !startsWith(github.head_ref, 'changeset-release/') }}
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            const body = [
+              '## 🚨🚨🚨 Docs migration in progress 🚨🚨🚨',
+              '',
+              'We are actively migrating UI extension reference docs to MDX in the `areas/platforms/shopify-dev` zone of the monorepo. This impacts docs for the following surfaces:',
+              '',
+              '- [Admin UI extensions](https://shopify.dev/docs/api/admin-extensions)',
+              '- [App Home](https://shopify.dev/docs/api/app-home)',
+              '- [Checkout UI extensions](https://shopify.dev/docs/api/checkout-ui-extensions)',
+              '- [Customer account UI extensions](https://shopify.dev/docs/api/customer-account-ui-extensions)',
+              '- [POS UI extensions](https://shopify.dev/docs/api/pos-ui-extensions)',
+              '',
+              'During this migration, please be aware of the following:',
+              '',
+              '**`.doc.ts` files are being deprecated.** Changes to `.doc.ts` files in this repo will **not** be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the `areas/platforms/shopify-dev` zone of the monorepo instead.',
+              '',
+              '**Doc comments in `.ts` source files** (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the `@shopify/generate-docs` library that isn\'t yet available. Updates to doc comments may not produce the expected output until the migration is complete.',
+              '',
+              '**Examples** that previously lived in this repo are being moved to the `areas/platforms/shopify-dev` zone of the monorepo and should be authored there going forward.',
+              '',
+              '### What should I do?',
+              '',
+              '- If your PR includes changes to **`.doc.ts` files**, **doc comments**, or **examples**, please reach out to us in [#devtools-proj-templated-refs](https://shopify.enterprise.slack.com/archives/C099RJCHAKE) so we can help ensure your updates are captured correctly.',
+              '- If your PR is limited to **source code changes** (non-docs), you can ignore this notice.',
+              '',
+              'Thanks for your patience while we complete the migration! 🙏',
+            ].join('\n');
+
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              body,
+            });