Skip to content

Fix theme pull, push, and package to cover all theme files - #8543

Open
karreiro wants to merge 1 commit into
mainfrom
fix-theme-file-sync-fix
Open

karreiro wants to merge 1 commit into
mainfrom
fix-theme-file-sync-fix

Conversation

@karreiro

@karreiro karreiro commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Shopify CLI does not handle DESIGN.md returned by the checksums API.

WHAT is this pull request doing?

Include DESIGN.md in theme pull, push, and package.

How to manually test your changes?

shopify theme pull
shopify theme push
shopify theme package

Notice that DESIGN.md is pulled, pushed, and included in the generated package.

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

The changelog entry is included in the 4.8 patch release.

Assisted-By: devx/b2d440f7-e236-42a9-a6ae-e4e7085b2daa
Copilot AI lite review requested due to automatic review settings September 14, 2026 17:56
@karreiro
karreiro requested a review from a team as a code owner September 14, 2026 17:56
@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Sep 14, 2026

Copilot AI 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.

🟡 Changes recommended

Correct the fixture checksum in the filesystem test and add the missing patch changeset.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds DESIGN.md support to theme pull, push, and package workflows.

Changes:

  • Discovers and partitions DESIGN.md.
  • Includes it in upload, deletion, and generated packages.
  • Adds fixtures and test coverage.
File summaries
File Summary
packages/theme/src/cli/utilities/theme-uploader.ts Handles documentation ordering during synchronization.
packages/theme/src/cli/utilities/theme-uploader.test.ts Tests DESIGN.md upload and deletion behavior.
packages/theme/src/cli/utilities/theme-fs.ts Discovers and categorizes DESIGN.md.
packages/theme/src/cli/utilities/theme-fs.test.ts Tests discovery and partitioning; expected checksum requires correction.
packages/theme/src/cli/utilities/fixtures/theme/DESIGN.md Adds a DESIGN.md fixture.
packages/theme/src/cli/services/package.ts Includes DESIGN.md in generated packages.
packages/theme/src/cli/services/package.test.ts Verifies packaged DESIGN.md inclusion.
Review details

Suppressed comments (1)

packages/theme/src/cli/services/package.ts:10

  • This adds user-facing theme packaging behavior, but there is no new .changeset file in the PR even though the checklist says one was added. Add a patch changeset for the theme package before merging.
  'DESIGN.md',
  • Files reviewed: 7/7 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

// Check that all expected files are present with correct checksums
const expectedFiles = [
{checksum: '6e3520cc5a5c4cdb1267f36406c732a1', key: 'AGENTS.md'},
{checksum: 'f5e9ce97aef578fc4e2e369a3c271234', key: 'DESIGN.md'},
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants