Skip to content

add missing js doc comment descriptions for hydrogen 2025-07 gen docs v1 #9121

add missing js doc comment descriptions for hydrogen 2025-07 gen docs v1

add missing js doc comment descriptions for hydrogen 2025-07 gen docs v1 #9121

Workflow file for this run

name: 🚀 CI
on: [pull_request]
jobs:
lint:
name: ⬣ ESLint
runs-on: ubuntu-latest
timeout-minutes: 15
concurrency:
group: ci-lint-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: ⎔ Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: 📥 Install dependencies
run: |
npm ci
npm rebuild
- name: 🔬 Lint
run: npm run lint
format:
name: ⬣ Prettier
runs-on: ubuntu-latest
timeout-minutes: 15
concurrency:
group: ci-format-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: ⎔ Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: 📥 Install dependencies
run: |
npm ci
npm rebuild
- name: 🔬 Check Formatting
run: npm run format:check
typecheck:
name: Typescript
runs-on: ubuntu-latest
timeout-minutes: 15
concurrency:
group: ci-typecheck-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: ⎔ Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: 📥 Install dependencies
run: |
npm ci
npm rebuild
# Enabling the turbo cache causes deployments to fail intermittently.
# The build step fails with dependency issues. More investigation needed.
# - name: 💾 Turbo cache
# id: turbo-cache
# uses: actions/cache@v3
# with:
# path: |
# node_modules/.cache/turbo
# **/.turbo
# key: turbo-${{ github.job }}-${{ github.ref_name }}-${{ github.sha }}
# restore-keys: |
# turbo-${{ github.job }}-${{ github.ref_name }}-
- name: 📦 Build packages and templates
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run build:all
- name: ✅ Typecheck
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run typecheck
- name: 🧑‍💻 CLI manifest check
run: 'test -z "$(git status --porcelain "packages/cli/oclif.manifest.json" )" || { echo -e "Run npm generate:manifest in packages/cli before pushing new commands or flags. Diff here:\n\n$(git diff)" ; exit 1; }'
test_e2e:
name: ⬣ E2E tests
runs-on: ubuntu-latest
timeout-minutes: 15
concurrency:
group: ci-e2e-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: ⎔ Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: 📥 Install dependencies
run: |
npm ci
npm rebuild
- name: 📦 Build packages and templates
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run build:all
- name: 🎭 Install Playwright Chromium
run: npx playwright install chromium --with-deps
- name: 🧪 Run E2E tests
run: npx playwright test --workers=1
- name: 📤 Upload Playwright Report
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
if: ${{ !cancelled() }}
with:
name: playwright-report
path: playwright-report/
retention-days: 30
test_unit:
name: ⬣ Unit tests
runs-on: ubuntu-latest
timeout-minutes: 15
concurrency:
group: ci-test-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: ⎔ Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: 📥 Install dependencies
run: |
npm ci
npm rebuild
- name: 📦 Build packages and templates
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run build:all
- name: 🔬 Test
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run test
validate_recipes:
name: ⬣ Validate Recipes
runs-on: ubuntu-latest
timeout-minutes: 15
concurrency:
group: ci-validate-recipes-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: ⎔ Setup node
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version-file: '.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: 📥 Install dependencies
run: |
npm ci
npm rebuild
- name: 📦 Build packages
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run build:pkg
- name: 📥 Install dependencies (cookbook)
working-directory: cookbook
run: |
npm ci
npm rebuild
- name: 📝 Validate schema
working-directory: cookbook
run: npm run cookbook -- schema && git diff --exit-code recipe.schema.json
- name: 🧐 Validate Recipes
working-directory: cookbook
run: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK=false npm run cookbook -- validate