understanding-saleor-domain

Align local Saleor Configurator YAML state with remote deployments.

29|5|Updated Jan 21, 2025
One-click install
npx skills add https://github.com/saleor/configurator --skill understanding-saleor-domain
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: understanding-saleor-domain
Source: https://github.com/saleor/configurator/tree/main/.claude/skills/understanding-saleor-domain
Command: npx skills add https://github.com/saleor/configurator --skill understanding-saleor-domain

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provides deep domain knowledge about Saleor and Configurator rules, including entity identification, deployment pipeline stages, and YAML configuration patterns.

Core Features & Use Cases

  • Entity identification: Slug-based, name-based, and singleton patterns.
  • Deployment pipeline: Stage order, dependencies, and selective deployment considerations.
  • Schema patterns: YAML configuration structure and validation expectations.

Quick Start

Ask questions about why a Product requires an existing ProductType before deployment or how stages depend on each other.

Frequently Asked Questions about understanding-saleor-domain

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I align my local Saleor Configurator YAML with remote deployments?

Aligning YAML state across environments requires understanding entity identification rules (slug vs. name), deployment stage dependencies, and schema validation. The Saleor domain rules explain how Products reference ProductTypes, how stages must be sequenced, and how to detect configuration drift between local and remote states using diff comparison.

What are Saleor entity identification rules for deployment?

Saleor uses slug-based, name-based, and singleton patterns to identify entities in YAML configurations. Slug identification is immutable and preferred for cross-reference validation; name-based identification requires careful handling during migrations. Understanding these patterns prevents duplicate detection failures and ensures proper entity resolution during deployment.

Why do some Saleor resources require existing dependencies before deployment?

Saleor enforces stage dependency sequencing where certain resources—like Products—require existing prerequisite resources like ProductTypes. The deployment pipeline respects these dependencies to prevent validation failures. Stage order determines which entities deploy first, and cross-reference validation ensures all dependencies resolve correctly.

How do deployment stages work in Saleor configuration-as-code?

Saleor deployments organize entities into stages with defined ordering and dependency relationships. Each stage can deploy selectively, and dependencies between stages must be satisfied before proceeding. Understanding stage sequencing and selective deployment options prevents configuration conflicts and ensures repeatable, predictable infrastructure updates.

What YAML configuration patterns does Saleor use for schema validation?

Saleor YAML configurations follow specific schema patterns for entity definition, references, and metadata. Schema synchronization across environments requires validating structure against expected patterns. Knowing the correct YAML structure prevents deployment failures and ensures consistent behavior across local, staging, and production environments.

How do I detect and resolve configuration drift between environments?

Configuration drift occurs when local YAML diverges from remote deployment state. Diff and compare logic identifies misaligned entities, missing resources, and broken references. Saleor domain rules help you understand which differences are safe, which require migration, and how to synchronize state without data loss.