Agent-Skills.md

Agent Skills: Add Private Feature Flag

Use when adding a new private (developer experiments) feature flag to Ghost, including the backend registration and settings UI toggle.

UncategorizedID: tryghost/ghost/add-private-feature-flag

Repository

tryghost/ghost
TryGhostLicense: MIT
52,16411,395

Install this agent skill to your local

pnpm dlx add-skill https://github.com/TryGhost/Ghost/tree/HEAD/.claude/skills/add-private-feature-flag

Skill Files

Browse the full folder contents for add-private-feature-flag.

Download Skill

Loading file tree…

.claude/skills/add-private-feature-flag/SKILL.md

Skill Metadata

Name
add-private-feature-flag
Description
Use when adding a new private (developer experiments) feature flag to Ghost, including the backend registration and settings UI toggle.

Add Private Feature Flag

Overview

Adds a new private feature flag to Ghost. Private flags appear in Labs settings under the "Private features" tab, visible only when developer experiments are enabled.

Steps

  1. Add the flag to ghost/core/core/shared/labs.js

    • Add the flag name (camelCase string) to the PRIVATE_FEATURES array.

  2. Add a UI toggle in apps/admin-x-settings/src/components/settings/advanced/labs/private-features.tsx

    • Add a new entry to the features array with title, description, and flag (must match the string in labs.js).

  3. Run tests and update the config API snapshot

    • Unit: cd ghost/core && yarn test:single test/unit/shared/labs.test.js
    • Update snapshot and run e2e: cd ghost/core && UPDATE_SNAPSHOTS=1 yarn test:single test/e2e-api/admin/config.test.js
    • Review the diff of ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap to confirm only your new flag was added.

Notes

  • No database migration is needed. Labs flags are stored in a single JSON labs setting.
  • The flag name must be identical in labs.js, private-features.tsx, and the snapshot.
  • Flags are camelCase strings (e.g. welcomeEmailDesignCustomization).
  • For public beta flags (visible to all users), add to PUBLIC_BETA_FEATURES in labs.js instead and add the toggle to apps/admin-x-settings/src/components/settings/advanced/labs/beta-features.tsx.