skills.rest
simstudioai
simstudioaiOFFICIAL
Explore all skills by this author →
Website𝕏@simdotaiGitHub

add-block-preview

Gate block visibility across discovery surfaces using preview flags, AppConfig rules, and environment variables.

29.5k|3.8k|Updated Jan 5, 2025
Search Tags:#feature flags#gating#kill switch#appconfig#Sim#preview rollout#block visibility
One-click install
npx skills add https://github.com/simstudioai/sim --skill add-block-preview
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: add-block-preview
Source: https://github.com/simstudioai/sim/tree/main/.agents/skills/add-block-preview
Command: npx skills add https://github.com/simstudioai/sim --skill add-block-preview

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Shipping a new Sim block before it is ready for general availability risks exposing unfinished functionality to users across the toolbar, search, copilot mentions, and docs. This Skill manages block visibility gating so unreleased blocks stay hidden everywhere while already-placed instances keep executing.

Core Features & Use Cases

  • Preview Gating: Mark a block with preview: true so it is hidden by default on every discovery surface until revealed via AppConfig or the PREVIEW_BLOCKS env variable.
  • Staged Rollout: Reveal blocks to platform admins or specific orgs through the hosted block-visibility AppConfig document, then GA them with a config change and no code deploy.
  • Kill Switch: Pull an already-shipped block from discovery surfaces during an incident without stopping execution of workflows that already use it.
  • Use Case: You built a new integration block and want only a design-partner org to see it. Set preview: true on the BlockConfig, add an AppConfig rule with that org's ID, and deploy the config — the block appears with a " (Preview)" suffix for that org only.

Quick Start

Ask the AI to ship the new block as a hidden preview and reveal it only to admins using the block-visibility AppConfig document.

Frequently Asked Questions about add-block-preview

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

FAQPage Schema
How do I hide an unreleased block from the Sim toolbar and search?▼

Set `preview: true` on the block's BlockConfig. The block is then hidden by default on every discovery surface — toolbar, cmd+K search, copilot mentions, and docs — until revealed through AppConfig or the PREVIEW_BLOCKS environment variable.

How do I roll out a preview block to specific organizations?▼

Add a rule to the hosted block-visibility AppConfig document keyed by the block type, such as `{ "enabled": false, "orgIds": ["org_123"] }`, then start an AppConfig deployment. Any matching allowlist clause reveals the block with a " (Preview)" suffix.

Does hiding a block stop workflows that already use it?▼

No. Execution is never gated — the executor and serializer resolve blocks through the pure getBlock accessor, so placed instances keep running. Visibility gating only prevents new placement and discovery.

How do self-hosters reveal a preview block without AppConfig?▼

Set the PREVIEW_BLOCKS environment variable to a comma-separated list of block types. This is the off-AppConfig reveal path intended for self-hosted deployments and local development.

What steps are required to GA a preview block?▼

Delete `preview: true` from the BlockConfig, add the block's BlockMeta, regenerate docs, and remove the AppConfig entry. Self-hosters then see the block on their next upgrade.

Why does a gated block still appear in getAllBlocks output?▼

Gated blocks stay in getAllBlocks as clones with hideFromToolbar set to true, because consumers that use .find by block type rely on their presence. They are never filtered out of the registry.

Related Skills

Explore More Software Engineering Skills→
tunacosguntunacosgun

add-block

Generate a complete Add Block scaffold for Sim services with subBlocks and tool wiring.

Community
Advanced
theslashdojotheslashdojo

deployments

Manage Kubernetes Deployments to create, update, scale, and rollback stateless applications.

Official
Intermediate
zerobias-orgzerobias-org

gate-4a-unit-tests

Validate TypeScript unit-test suites for nock-only HTTP mocking and project standards.

Official
Advanced
redisredis
8.7k

feature-flags

Manage RedisInsight feature flag creation, promotion, and removal across backend and frontend.

Official
Advanced