For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • Overview
  • Learning Plans
    • Developer Foundations
    • Composable Developer
    • Stencil Developer
    • B2B Developer
  • Courses
        • Naming Your Theme and Theme Variations
        • Theme's Size
        • Lab Activity: Bundling a Customized Theme
        • Lab Activity: Bundle & Push the Stencil Theme
        • Troubleshooting 101 Theme Uploads
        • Version Control and Theme Updates
    • Learning Changelog
Dev Portal
LogoLogo
On this page
  • Bundling a Customized Theme
  • Bundling a Theme
  • Successful Bundling
CoursesStencil AdvancedModule 5: Deployment

Lab Activity: Bundling a Customized Theme

Was this page helpful?
Previous

Theme's Size

Next

Lab Activity: Bundle & Push the Stencil Theme

Built with

Plan: Stencil Developer

 Lesson 20 of 28 · 30 min

Objectives

  • Bundle a customized theme

Prerequisites

  • Completed a customized theme, tested and are ready to deploy live

Bundling a Customized Theme

You have verified all requirements have been met. Stencil CLI provides two options for creating a .zip file that contains all your theme’s essentials while excluding redundant components.

Note:

Writable Permissions Are Required

Without these permissions, bundling your theme will fail, blocking its upload to BigCommerce.

No Automatic Check for Dependencies

The stencil bundle and stencil push commands do not check for the dependencies that these build systems install. So if those dependencies are missing, these commands will not immediately report errors. However, your resulting .zip file will not properly upload to BigCommerce, and will not run properly on a storefront.

Verify Directory and File Permissions

If you have added any new subdirectories or files to your base theme, verify that you have:

Set newly added directories to permission 755 (drwxr-xr-x). Set newly added files to permission 644 (rw-r—r—).

Troubleshooting theme uploads.

  • Shrink Your Theme by Excluding Static Asses (WebDAV)
  • Staging a Theme for CDN Delivery

Bundling a Theme

Bundle Only

  1. Enter the following command in CLI:
stencil bundle
  1. The bundle command will notify you of its progress and completion
  2. A .zip file is generated

Check the resulting .zip file’s size. (It cannot exceed 50 MB). If your .zip file meets this requirement you are now ready to upload your theme.

If your .zip file exceeds 50 MB, you will need to use one of the following procedures to restructure your theme to a size that is manageable for upload to BigCommerce:

  1. Shrink your theme with the help of WebDAV
  2. Stage your Theme for CDN Delivery to restructure your theme to a size that’s manageable to upload to BigCommerce. See Checking a Theme’s Size for more information

Successful Bundling

Successful Bundling

Stencil CLI will display:

  • “ok” confirmations
  • “not ok” errors
  • warnings for individual substeps in bundling and uploading your theme If bundling is successful, you will next see a “Processing” progress bar to track the upload.

Note

If bundling your theme triggers multiple lint errors related to the bundle.js file, then your theme is missing the .eslintignore file. Please retrieve this file from the Stencil Cornerstone repo, then re-run stencil bundle or stencil push.