[Bug]: Failed to upload file config/settings_data.json without a good reason

[DawidKopys]

Please confirm that you have:

• Searched existing issues to see if your issue is a duplicate. (If you’ve found a duplicate issue, feel free to add additional information in a comment on it.)
• Reproduced the issue in the latest CLI version.

In which of these areas are you experiencing a problem?

Theme

Expected behavior

The CLI should push both settings_data.json and settings_schema.json config files without any issues.
It should work since the new settings in the settings_data.json file meet new settings' schema defined in the settings_schema.json.

Actual behavior

The CLI pushes only settings_schema.json, and provides a warining in the command output:

╭─ warning ────────────────────────────────────────────────────────────────────╮
│                                                                              │
│  The theme 'Development (d7dc3d-Dawids-MacBook-Pro)' (#177681236314) was     │
│  pushed with errors                                                          │
│                                                                              │
│  Next steps                                                                  │
│    • View your theme [1]                                                     │
│    • Customize your theme at the theme editor [2]                            │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

Verbose output

I can't paste the verbose output here as github shows "Field can not be longer than 65536 characters" error...

So, here is the file instead:

push-output.txt

Reproduction steps

1. Initialize a fresh theme: shopify theme init
2. Push the theme to a dev store shopify push --store=<some_dev_store>
3. In the config/settings_schema.json file, change logo_width setting's:

• step value to 4,
• min value to 52 (so that it is divisable by the new step)

4. In the config/settings_data.json file, change logo_width value to 84 (it fit's into new step we set in the previous step!)

7. Run shopify theme push, result - you get ann error:

Error's text:

╭─ error ──────────────────────────────────────────────────────────────────────╮
│                                                                              │
│  config/settings_data.json                                                   │
│                                                                              │
│  Setting 'logo_width' must be a step in the range                            │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

╭─ error ──────────────────────────────────────────────────────────────────────╮
│                                                                              │
│  config/settings_schema.json                                                 │
│                                                                              │
│  New schema is incompatible with the current setting value. Setting          │
│  'logo_width' must be a step in the range                                    │
│                                                                              │


╭─ warning ────────────────────────────────────────────────────────────────────╮
│                                                                              │
│  The theme 'futuristic-style-theme' (#179287621978) was pushed with errors   │
│                                                                              │
│  Next steps                                                                  │
│    • View your theme                                                         │
│    • Customize your theme at the theme editor                                │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

This issue happens both on my local machine and in gitlab's CI.I am using Shopify CLI 3.74.0 on my local machine and 3.72.1 in the Gitlab CI.
Above reproduction presents the issue when using shopify cli on my local machine for ease of reproduction only. In reality, the issue appears in our Gitlab CI pipeline when we try to push to a live theme in a production store.

Operating System

MacOS Sonoma AND GitLab CI based on node:20 image

Shopify CLI version (shopify --version)

3.74.0

Shell

iTerm2

Node version (run node -v if you're not sure)

v20.18.0

What language and version are you using in your application?

No response

[aswamy]

It's usually pretty risky to modify settings_data.json directly since it's an auto-generated file.

Could you try only changing settings_schema.json, and do the following steps instead?

• Edit settings_schema.json to your liking (e.g. changing steps from 100 to 50 for page_width)
• Run shopify theme dev
• Open Theme Editor
• Change the theme to have a width using the new increment
• Save the theme
• Run shopify theme pull

You should have current block in settings_data.json changed

[DawidKopys]

In a real use case we are not modifying the settings_data.json manually. We do it through the theme editor, the way you suggested.

This issue is taking place in our GitLab CI pipeline. We are using GitLab instead of GitHub at our company, so we have created a custom integration with Shopify this way.

To be more precise, this issue might happen when we merge a feature branch into - for example - main.

The feature branch contains all changes done during feature implementation. This often includes changes in both settings_schema.json and settings_data.json (edited through the Theme Editor, during development).

After the merge happens, we then try to push our code into a theme corresponding to our main branch.
We do it with shopify theme push --theme=<theme_id>.
This command is where the issue appears.

The reproduction steps I have provided in the issue are here just to provide you with a simple way to reproduce the issue we encounted when executing shopify theme push command in our use case.

Hope this clarifies our issue to you.

[aswamy]

@DawidKopys Ok i do see the error!

I'll let the team know, but for now, you might have to make shopify theme push in multiple stages. Sorry for the inconvenience.

[github-actions]

This issue seems inactive. If it's still relevant, please add a comment saying so. Otherwise, take no action.
→ If there's no activity within a week, then a bot will automatically close this.
Thanks for helping to improve Shopify's dev tooling and experience.

P.S. You can learn more about why we stale issues here.

[DawidKopys]

Issue is still relevant and present on the latest Shopify CLI 3.76.2. Fixing this issue is very important for us as this bug could cause issues during deploy to a live theme in a production store!

I have edited the issue's reproduction steps to make it easier for everyone to understand the issue.

[jamesmengo]

Hey Dawid, thanks for reporting this issue!

This behaviour is happening because of the way the platform validates changes to these files to prevent users from changing either settings_schema or settings_data in a way that invalidates the other file.

What's happening here is the new the settings_schema and settings_data values invalidate the old/pre-existing values

I'm going to make a note to explore the implications of addressing this from the platform level, however in the meantime here is a workaround for CI:

1. Upload a new theme via the theme push command
2. Publish the newly created theme via theme publish -t <RETURNED_ID_FROM_STEP_1>

shopify theme push --json -u -t <GENERATE_THIS_NAME> 2>/dev/null | jq .theme.id will return you the theme ID

Since this fix won't ultimately live in the CLI, I'm going to close this issue for now. Please feel free to reopen if this doesn't resolve your issue!

[geonet-server]

I've ran into this issue a few times. I've found this to be quick fix:

Change the setting ID to something else in both the settings_schema.json and settings_data.json
Run shopify theme push, there should be no errors because it's treating it as a new setting.
Change the ID's back again then run shopify theme push again.