deploying-ui-bundle

Original：🇺🇸 English

Translated

MUST activate when the project contains a uiBundles/*/src/ directory or sfdx-project.json and the task involves deploying, pushing to an org, or post-deploy setup. Use this skill when deploying a UI bundle app to a Salesforce org. Covers the full deployment sequence: org authentication, pre-deploy build, metadata deployment, permission set assignment, data import, GraphQL schema fetch, and codegen. Activate when files like *.uibundle-meta.xml or sfdx-project.json exist and the user mentions deploying, pushing, org setup, or post-deploy tasks.

3installs

Sourceforcedotcom/afv-library

Added on2026-04-19

NPX Install

npx skill4agent add forcedotcom/afv-library deploying-ui-bundle

SKILL.md Content

View Translation Comparison →

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

Set default org
Fetch schema (GraphQL introspection) — writes
```
schema.graphql
```
at project root
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

Check/authenticate org
Build UI bundle (if deploying UI bundles)
Deploy metadata
Assign permissions and configure
Import data (if data plan exists, with user confirmation)
Fetch GraphQL schema and run codegen
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:

Discover and assign permission sets (or ask the user)
If
```
data/data-plan.json
```
exists, ask the user about data import
Re-run schema fetch and codegen from the UI bundle directory