Deploying Ui Bundle
Run the canonical Salesforce org sequence for UI bundle apps: auth, build dist/, deploy metadata, then post-deploy setup.
Install
npx skills add https://github.com/forcedotcom/sf-skills --skill deploying-ui-bundleWhat is this skill?
- Mandatory activation when uiBundles/*/src/ or sfdx-project.json exists and deploy/push is mentioned
- Ordered pipeline: org authentication → npm build for dist/ → manifest or full metadata deploy
- Post-deploy steps include permission sets, data import, GraphQL schema fetch, and codegen after metadata lands
- Treats missing or stale dist/ as a hard pre-deploy build requirement
- Aligns deployment order so schema fetch reflects org state only after metadata deploy completes
Adoption & trust: 667 installs on skills.sh; 513 GitHub stars; 3/3 security scanners passed (skills.sh audits).
Recommended Skills
Azure Deploymicrosoft/azure-skills
Azure Preparemicrosoft/azure-skills
Azure Storagemicrosoft/azure-skills
Azure Validatemicrosoft/azure-skills
Appinsights Instrumentationmicrosoft/azure-skills
Azure Resource Lookupmicrosoft/azure-skills
Journey fit
Primary fit
Deploying compiled UI bundles and Salesforce metadata is the gate between local build work and a live org—canonical shelf is Ship when you push and finish launch prep on the target org. Launch subphase covers org push, permission sets, and post-deploy wiring that make the app usable in production Salesforce, not just compiling source.
Common Questions / FAQ
Is Deploying Ui Bundle safe to install?
skills.sh reports 3 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.
SKILL.md
READMESKILL.md - Deploying Ui Bundle
# Deploying a UI Bundle The order of operations is critical when deploying to a Salesforce org. This sequence reflects the canonical flow. ## Step 1: Org Authentication Check if the org is connected. If not, authenticate. All subsequent steps require an authenticated org. ## Step 2: Pre-deploy UI Bundle Build Install dependencies and build the UI bundle to produce `dist/`. Required before deploying UI bundle entities. Run when: deploying UI bundles and `dist/` is missing or source has changed. ## Step 3: Deploy Metadata Check for a manifest (`manifest/package.xml` or `package.xml`) first. If present, deploy using the manifest. If not, deploy all metadata from the project. Deploys objects, layouts, permission sets, Apex classes, UI bundles, and all other metadata. Must complete before schema fetch — the schema reflects org state. ## Step 4: Post-deploy Configuration Deploying does not mean assigning. After deployment: - **Permission sets / groups** — assign to users so they have access to custom objects and fields. Required for GraphQL introspection to return the correct schema. - **Profiles** — ensure users have the correct profile. - **Other config** — named credentials, connected apps, custom settings, flow activation. Proactive behavior: after a successful deploy, discover permission sets in `force-app/main/default/permissionsets/` and assign each one (or ask the user). ## Step 5: Data Import (optional) Only if `data/data-plan.json` exists. Delete runs in reverse plan order (children before parents). Import uses Anonymous Apex with duplicate rule save enabled. Always ask the user before importing or cleaning data. ## Step 6: GraphQL Schema and Codegen 1. Set default org 2. Fetch schema (GraphQL introspection) — writes `schema.graphql` at project root 3. Generate types (codegen reads schema locally) Run when: schema missing, or metadata/permissions changed since last fetch. ## Step 7: Final UI Bundle Build Build the UI bundle if not already done in Step 2. ## Summary: Interaction Order 1. Check/authenticate org 2. Build UI bundle (if deploying UI bundles) 3. Deploy metadata 4. Assign permissions and configure 5. Import data (if data plan exists, with user confirmation) 6. Fetch GraphQL schema and run codegen 7. Build UI bundle (if needed) ## Critical Rules - Deploy metadata **before** fetching schema — custom objects/fields appear only after deployment - Assign permissions **before** schema fetch — the user may lack FLS for custom fields - Re-run schema fetch and codegen **after every metadata deployment** that changes objects, fields, or permissions - Never skip permission set assignment or data import silently — either run them or ask the user ## Post-deploy Checklist After every successful metadata deploy: 1. Discover and assign permission sets (or ask the user) 2. If `data/data-plan.json` exists, ask the user about data import 3. Re-run schema fetch and codegen from the UI bundle directory