@xola/ui-kit 2.4.1-x2-14336.4 → 2.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/build/ui-kit.mjs +1353 -1333
- package/build/ui-kit.umd.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,6 +18,7 @@ Storybook is public at [ui.xola.io](https://ui.xola.io). You can preview compone
|
|
|
18
18
|
- [AI Prompt for Integration](#ai-prompt-for-integration)
|
|
19
19
|
- [Development](#development)
|
|
20
20
|
- [Local Package Linking](#local-package-linking)
|
|
21
|
+
- [Preview Releases](#preview-releases)
|
|
21
22
|
- [Troubleshooting](#troubleshooting)
|
|
22
23
|
- [Deployment](#deployment)
|
|
23
24
|
|
|
@@ -192,6 +193,34 @@ Use an npm workspace to test local `ui-kit` changes against another project befo
|
|
|
192
193
|
|
|
193
194
|
Changes in `ui-kit` now appear in `your-project`.
|
|
194
195
|
|
|
196
|
+
## Preview Releases
|
|
197
|
+
|
|
198
|
+
Every pull request publishes an installable build of `@xola/ui-kit` to
|
|
199
|
+
[pkg.pr.new](https://pkg.pr.new). Use it to test a PR's changes in `x2-checkout` or `x2-seller`
|
|
200
|
+
before the change lands on `master` and gets a real version.
|
|
201
|
+
|
|
202
|
+
A bot comments the install command on the PR. It looks like this:
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
npm install https://pkg.pr.new/@xola/ui-kit@448
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
The number is the PR number. Commit-specific URLs also work, so a stale install can be pinned to
|
|
209
|
+
one commit:
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
npm install https://pkg.pr.new/@xola/ui-kit@a12fb04
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
Notes:
|
|
216
|
+
|
|
217
|
+
- Builds expire, so these URLs are for testing only. Never commit one to a `package.json` that
|
|
218
|
+
ships.
|
|
219
|
+
- Every push to the pull request publishes a new build and cancels the run still building the
|
|
220
|
+
previous commit (`.github/workflows/pkg-pr-new.yml`).
|
|
221
|
+
- The [pkg-pr-new GitHub App](https://github.com/apps/pkg-pr-new) must be installed on the `xola`
|
|
222
|
+
org for the workflow to publish.
|
|
223
|
+
|
|
195
224
|
## Troubleshooting
|
|
196
225
|
|
|
197
226
|
**Changes in `ui-kit` don't show up in `your-project`.** npm likely installed a separate copy in
|