refactor(faststore): recommend faststore cms-sync for CMS schema sync - #90
Open
renatamottam wants to merge 1 commit into
Open
refactor(faststore): recommend faststore cms-sync for CMS schema sync#90renatamottam wants to merge 1 commit into
faststore cms-sync for CMS schema sync#90renatamottam wants to merge 1 commit into
Conversation
Update the faststore-storefront skill to recommend the consolidated
`faststore cms-sync` command as the primary way to sync the CMS schema,
instead of manually running `vtex content generate-schema` +
`vtex content upload-schema`. The manual pair remains documented as a
fallback.
`faststore cms-sync` (in @faststore/cli) auto-detects
cms/faststore/components and cms/faststore/pages, generates
cms/faststore/schema.json, and runs generate-schema + upload-schema for
you. The skill previously prohibited it, which is outdated.
Changes:
- skill.md: new "CMS schema - recommended sync" section; workflow,
canonical commands, checklist and reference table updated.
- references/cms-schema-and-section-registration.md: Critical Rules,
Phase 4, end-to-end workflow and non-interactive upload realigned;
clarified account (api.storeId) vs store ID prompt (contentSource.project).
- references/project-structure-routes-and-config.md: CMS schema note updated.
- scripts/cms-sync.sh: now calls `faststore cms-sync` (manual fallback in comments).
- Regenerated exports/, rules/, skills/ mirrors.
Caveats kept in the skill:
- Requires an up-to-date @vtex/cli-plugin-content.
- Upload step is interactive: at the store ID prompt enter contentSource.project
from discovery.config.js (NOT hardcoded "faststore"); published id is {account}.{project}.
- Content-type definitions belong in cms/faststore/pages/.
Scope: covers Content Platform (CP) projects.
🛡️ SDD Check — action requiredI couldn't detect an SDD in this PR. Please check one option below (requires write access to the repo):
|
Contributor
|
✅ Validation passed — all checks OK Full validation output |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Update the
faststore-storefrontskill to recommend the consolidatedfaststore cms-synccommand as the primary way to sync the CMS schema, instead of manually runningvtex content generate-schema+vtex content upload-schema. The manual pair remains documented as a fallback.Why:
faststore cms-sync(in@faststore/cli, verified on v4.4.0) is a wrapper that auto-detectscms/faststore/componentsandcms/faststore/pages, generatescms/faststore/schema.json, and runsgenerate-schema+upload-schemafor you. The official docs recommend this consolidated flow. The skill previously prohibitedfaststore cms-sync, which is outdated.Changes
skill.md: new "CMS schema — recommended sync" section; workflow steps, canonical commands, review checklist, and reference table updated. Store ID at the upload prompt is now derived fromcontentSource.project(removed the hardcodedsend "faststore\r").references/cms-schema-and-section-registration.md: Critical Rules, Phase 4, end-to-end workflow and non-interactive upload realigned; added a note distinguishing the login account (api.storeId) from the store ID prompt (contentSource.project).references/project-structure-routes-and-config.md: CMS schema note updated for consistency.scripts/cms-sync.sh: now callsfaststore cms-sync(manual fallback documented in comments).exports/,rules/, andskills/mirrors.Caveats kept in the skill
@vtex/cli-plugin-content(old versions fail with "Failed to fetch the base schema from the registry. Not Found"; fix:vtex plugins install @vtex/cli-plugin-content).contentSource.projectfromdiscovery.config.js(NOT the hardcodedfaststore); the published id is{account}.{project}.cms/faststore/pages/.Scope
Covers Content Platform (CP) projects (output
cms/faststore/schema.json, detectingcomponents+pages). Only the legacyyarn cms-sync/npm run cms-syncproject scripts remain discouraged.Contribution Checklist
tracks/faststore/skills/faststore-storefront/skill.md(lowercase)name,description,metadata.track,metadata.tagspresentbun run validate— all hard checks pass (pre-existing soft-check warnings on this skill are unchanged)bun run exportrun;exports/,rules/,skills/committedfaststore-storefront)faststorePublic Documentation Sync
This is a skill-body change (updates the recommended command/workflow), so catalog-level pages (e.g. the VTEX Skills guide, skill counts, install snippets) are not affected. However, the underlying behavior it documents may be described on developer-portal guides. The
vtex-docsMCP server was not available in the authoring environment, so the pages below could not be diffed automatically — please verify they already recommend the consolidatedfaststore cms-sync(and not only the manualvtex contentpair):Also search
developers.vtex.com/help.vtex.comforfaststore cms-syncandvtex content upload-schema. If any guide recommends only the manual pair, open a follow-up invtex/dev-portal-content.