Auto Deployments

Automatically deploy your applications on commits, pull requests, and custom patterns.

Overview

Stormkit can automatically deploy your applications when code is pushed to your repository. By default, auto deployments are disabled for new applications.

Enabling Auto Deployments

1. Navigate to Config

   Go to Application > Environment > Config

2. Select Auto Deploy Option

   Click the Auto Deploy dropdown and choose your preferred option

3. Save Configuration

   Your changes are saved automatically

Deployment Modes

Disabled

No automatic deployments. You must manually trigger deployments through the UI or deployment trigger API.

Use case: Production environments where you want full control over deployments.

All Branches

Every branch that receives a commit is deployed automatically.

Use case: Development environments where you want to preview every branch.

This option can generate many deployments. Consider using custom branch patterns for cost control.

Custom Branches

Deploy only branches matching specific patterns. Supports both regex and glob patterns.

Pattern Examples

Feature Branches

feature/*

Use case: Staging and preview environments where you want to limit deployments to specific branch naming conventions.

Custom Commits

Deploy only commits matching specific patterns within configured branches.

How It Works

1. Branch Check

   Stormkit first checks if the commit’s branch matches the environment’s configured branch

2. Pattern Evaluation

   If the branch matches, the commit message is evaluated against your pattern

3. Deployment Trigger

   Only commits matching both criteria trigger a deployment

Commit Pattern Examples

Release Tags

v[0-9]+\.[0-9]+\.[0-9]+

Example Usage:

# This commit will trigger deployment
git commit -m "deploy: new feature"
git push origin main

# This commit will NOT trigger deployment
git commit -m "wip: work in progress"
git push origin main

Use case: Production environments where you want to deploy only on release commits or specific keywords.

Pattern Types

Stormkit supports two pattern types:

Glob Patterns

Simple wildcard matching:

• * matches any characters
• feature/* matches feature/login, feature/checkout
• release-* matches release-v1, release-v2

Regular Expressions

Advanced pattern matching:

• ^main$ matches only “main” exactly
• (main|develop) matches either “main” or “develop”
• feature/[0-9]+ matches “feature/123”, “feature/456”

Preview Links

When auto deployments are enabled, Stormkit automatically posts preview links to pull/merge requests.

Preview Link Features

• Unique URL for each deployment
• Build status (pending, success, failure)
• Direct link to deployment logs
• Automatically updated when new commits are pushed

Disabling Preview Links

If you don’t want Stormkit to comment on pull requests:

1. Go to Environment > Config
2. Find Preview links setting
3. Toggle it off

Deployments still occur; only the PR comments are disabled.

Auto Publish

Auto publish automatically promotes successful deployments to production.

Enabling Auto Publish

Auto publish skips manual review. Only enable for branches with strict CI/CD and code review processes.

1. Navigate to Config

   Go to Environment > Config

2. Enable Auto Publish

   Toggle Auto publish on

Auto Publish Behavior

• Only applies to commits on the default branch
• Deployment must succeed (exit code 0)
• Status checks (if configured) must pass
• Deployment is automatically published to environment URL

Branch Matching Strategy

Stormkit uses the following strategy to match branches:

1. Exact match: Branch name exactly matches configuration
2. Glob match: Branch name matches glob pattern
3. Regex match: Branch name matches regular expression

Best Practices

Development Environment

Auto Deploy: All branches
Preview Links: Enabled
Auto Publish: Disabled

Deploy every branch for maximum visibility during development.

Staging Environment

Auto Deploy: Custom branches (main|develop|feature/*)
Preview Links: Enabled
Auto Publish: Disabled

Deploy main, develop, and feature branches for testing.

Production Environment

Auto Deploy: Custom commits (^v[0-9]+\.[0-9]+\.[0-9]+$)
Preview Links: Disabled
Auto Publish: Enabled (with status checks)

Only deploy release tags and auto-publish after status checks pass.

Troubleshooting

Deployment Not Triggering

Check auto deploy is enabled

Verify that Auto Deploy is not set to “Disabled” in environment config.

Verify branch pattern

Ensure your branch name matches the configured pattern. Test your regex/glob pattern.

Check repository access

Stormkit needs access to your repository. See Troubleshooting.

Webhook delivery

Check if your Git provider is sending webhooks to Stormkit. You may need to reconfigure the integration.

Preview Links Not Appearing

• Verify Preview links setting is enabled
• Check if Stormkit has permission to comment on pull requests
• Ensure the deployment succeeded (failed deployments may not post links)

Related Documentation

Configuration

Configure build settings and environment variables

Status Checks

Add automated tests before publishing