Deployment Actions

Storefront Hosting enables its users to trigger the deployment in two different ways that result in the same action. On this page, you can find a detailed explanation of both options.

Deployment from the SCAYLE Panel

An easy way to trigger a deployment is from the SCAYLE Panel by clicking on the "Deploy" button, either as part of the "Overview" or "Deployments" section. It always opens a dedicated pop-up window, which contains the reference (tag or branch), required to be selected to trigger the deployment. For an easier selection, use our search function to find a specific reference name from the list.

Successfully triggering a deployment leads you to the Deployment Detail Page. See more details on it in the Deployment in Progress section.

Deployment from the Storefront CLI

The @scayle/storefront-cli provides a deploy command to initiate new deployments of your Storefront Application to Storefront Hosting.

Before you deploy, it's crucial to ensure your environment and environment variables are properly set up. You'll find detailed guidance on environment configuration here, managing environment variables here, and setting up your essential deploy token for authentication here.

Once your environment is ready, you can use the deploy command with the following required flags:

--tenant-space: Identifies the correct context within the SCAYLE Core System.
--shop-key: Identifies the specific shop. The value can be found on the general shop dashboard page in the SCAYLE Panel.
--env-key: Identifies the correct environment for the deployment. To deploy to the default environment created by SCAYLE automatically, use main.
--deploy-token: Authenticates against the SCAYLE PaaS System.
--git-rev: Specifies the Git revision (e.g., a tag or branch name) that should be checked out for the deployment.
--no-config-file (optional): This flag disables the generation of a config file, making it particularly useful when running deployments in a Continuous Integration (CI) environment where interactive input or persistent configuration files are not desired or possible.

npx @scayle/storefront-cli deploy \
  --tenant-space <YOUR_TENANT_SPACE> \
  --shop-key <YOUR_SHOP_KEY> \
  --env-key <YOUR_ENV_KEY> \
  --git-rev <rev> \
  --deploy-token <YOUR_DEPLOY_TOKEN> \
  --no-config-file

Upon successful execution, the deploy command will initiate the deployment process to Storefront Hosting and display the build logs directly in your terminal, allowing you to monitor the progress of your application's deployment.

Rollback a Deployment

Rollback deployment restores the application to a previously working version, quickly resolving any issues introduced by a problematic new release and minimizing disruption. These rollbacks are really quick, as they utilize a previous build artifact, eliminating the need to rebuild the application.

There are two different ways to trigger the rollback action as part of the SCAYLE Panel: instant rollback and particular rollback.

Instant Rollback

If you need to quickly revert your application to the last successful deployment, you can do so easily. Just head to the "Overview" tab, where you'll find an "Instant Rollback" action specifically designed for this purpose.

Particular Rollback

For more flexibility, if you wish to roll back your deployment to any other previously successful deployment (not just the last one), navigate to the "Deployments" tab. There, a "Rollback" side-action will be available for you to choose your desired version.