Submit an update for your theme after completing development.Description#
The update
command allows you to submit a new version of your theme to the Zid platform. Use this command after making changes to your theme and when you're ready to release an update.Usage#
Required Options#
--theme_id <theme_id>
: The unique identifier of the theme you want to update. You can find this ID using the themes-cli list
command.
--change_type <change_type>
: The type of changes made in this update. Valid options are:major: Significant changes that may affect theme compatibility.
minor: New features added without breaking changes.
patch: Bug fixes and small improvements.
--release_notes <release_notes>
: A brief description of the changes made in this update. Use quotation marks if your notes contain spaces.
Authentication#
This command requires authentication with your Zid partner account.If you're not logged in, you'll be prompted to log in.
Use the themes-cli login
command to authenticate.
Process#
1.
Build the Theme: The command will build your theme and prepare it for submission.
2.
Submit Update: The new version of your theme will be uploaded to Zid.
3.
Release Notes: Provide clear release notes to help merchants understand the changes.
Example#
Expected Output#
Building theme...
Uploading updated theme...
Successfully updated theme "abc123def456" with version "2.1.0".
Release Notes: "Added new footer design and improved mobile responsiveness"
Important Notes#
Build Process: The command will build your theme and upload it to Zid, so if your internet connection is slow, the process may take some time.
Theme ID: Ensure that the theme_id
corresponds to an existing theme in your Zid partner account.
Change Type: Choose the change_type
carefully as it affects the version number of your theme.
Release Notes: Provide clear and concise release notes to inform merchants about what's new or changed.
Troubleshooting#
If you encounter issues during the update process:Problem | Solution |
---|
Slow upload due to internet speed | Ensure you have a stable and fast internet connection to reduce upload time. |
Incorrect theme ID | Verify that the theme_id matches an existing theme in your Zid partner account. |
Missing release notes or invalid format | Ensure release notes are provided and enclosed in quotation marks if they contain spaces. |
Authentication issues | Run the themes-cli login command to ensure you're authenticated. |
Modified at 2025-01-23 11:08:30