UNPKG

zephyr-rspack-plugin

Version:

Repack plugin for Zephyr

ZephyrCloudIO/zephyr-packages

78 lines (61 loc) • 4.17 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
--- name: zephyr-core description: Use when the user asks about Zephyr setup, with-zephyr, SDK selection, versions, tags, environments, snapshot/version URLs, dashboard workflows, docs, or public env vars. license: Apache-2.0 metadata: author: Zephyr Cloud IO purpose: Use when the user asks about Zephyr setup, with-zephyr, SDK selection, versions, tags, environments, snapshot/version URLs, dashboard workflows, docs, or public env vars. domain: sdk type: core sources: - ZephyrCloudIO/zephyr-packages:**/skills/zephyr-core/references/*.md - ZephyrCloudIO/zephyr-packages:**/scripts/sync-package-skills.mjs --- # Zephyr Core Use this skill for Zephyr SDK adoption and build-integrated deployment. It ships with every published Zephyr package, including supporting libraries that are not themselves build plugins. Do not assume the package containing this guide exports `withZephyr`; choose the actual integration for the application's stack. Prefer a more specific skill shipped alongside this one for its supported task, such as `zephyr-vite` or `create-zephyr-apps`. Check the installed integration's README, exported types, and peer compatibility before applying code examples. Zephyr is a build-integrated deployment platform for frontend and frontend-adjacent apps: it plugs into the build, publishes immutable versions, and lets users route traffic through tags and environments. ## What to cover - Start with the smallest useful answer. - Prefer Zephyr's user-facing model first: setup -> build -> version URL -> tags/envs -> promote/rollback. - Use repo/code-path nuance only when it clarifies behavior or corrects docs drift. - If the question is really about remote resolution, hosts/remotes, `zephyr:dependencies`, or multi-bundler Module Federation, switch to `../zephyr-module-federation/SKILL.md`. - First-time users usually need: a supported stack or fallback upload path, Zephyr auth/account access, and git metadata for repo/branch/commit identity. ## What Zephyr does - Zephyr integrates with the build and publishes immutable frontend versions. - Zephyr gives users permanent version URLs plus mutable tags and environments. - Zephyr can manage public runtime config overrides and deployment routing. - Zephyr does not replace the app's own framework/bundler config; it integrates into it. - Zephyr does not make public `ZE_PUBLIC_*` values secret. ## Core mental model - Zephyr plugs into the app build through a bundler/framework integration. - A build creates an immutable version/snapshot and a permanent version URL. - Tags and environments are mutable pointers on top of immutable builds. - Promotion and rollback are mostly pointer changes, not rebuilds. - `ZE_PUBLIC_*` values can be captured at build time and overridden per environment later. ## Answer flow 1. Identify the user's stack and deployment goal. 2. Read `references/sdk-setup.md` for setup guidance. 3. Read `references/deployment-model.md` for versions, snapshots, tags, envs, and dashboard workflows. 4. Read `references/env-vars.md` if the task mentions env vars, runtime config, build once deploy everywhere, or `ZE_PUBLIC_*`. 5. Read `references/examples-resume.md` when the user wants concrete starter patterns. 6. Read `references/docs-map.md` when deeper docs links are useful. 7. Read `references/troubleshooting.md` when setup/build/auth/git issues appear. ## Source priorities - Canonical public docs: `https://docs.zephyr-cloud.io` - Raw docs path pattern: `https://docs.zephyr-cloud.io/<path>.md` - Docs index: `https://docs.zephyr-cloud.io/llms.txt` - Community help: `https://discord.gg/zephyrcloud` - Architecture docs: `https://docs.zephyr-cloud.io/reference/architecture.md` - Public docs source: `https://docs.zephyr-cloud.io` - Examples source: `https://github.com/ZephyrCloudIO/zephyr-examples` ## Guardrails - Do not invent SDK names; verify against `references/sdk-setup.md`. - Do not blur version vs tag vs environment; explain the distinction plainly. - Do not present `ZE_PUBLIC_*` as secret storage. They are public client-facing values. - Call out docs drift when relevant instead of silently repeating conflicting details.