Skip to content

Commit fe4aee8

Browse files
committed
docs: add requirement for NPM_TOKEN and GH_TOKEN in README
Signed-off-by: Hendrik Ebbers <hendrik.ebbers@open-elements.com>
1 parent 05ba254 commit fe4aee8

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Upgrade prompt: `@open-elements/ui` 0.5.x → 0.6.0
1+
# Upgrade prompt: `@open-elements/ui` 0.4.x → 0.5.0
22

3-
`@open-elements/ui` 0.6.0 reorganises its dependency manifest: implementation-detail libraries moved from `peerDependencies` to regular `dependencies` so they install transitively. Consumer apps that listed those libs only to satisfy the peer-dep constraint can now drop them.
3+
`@open-elements/ui` 0.5.0 reorganises its dependency manifest: implementation-detail libraries moved from `peerDependencies` to regular `dependencies` so they install transitively. Consumer apps that listed those libs only to satisfy the peer-dep constraint can now drop them.
44

55
This file is a self-contained prompt for an agent (Claude Code, etc.) to run inside a consumer repo. Paste it verbatim.
66

77
---
88

99
## Prompt
1010

11-
You are working inside an app that depends on `@open-elements/ui`. Goal: upgrade to `^0.6.0` and remove dependencies that are now transitive.
11+
You are working inside an app that depends on `@open-elements/ui`. Goal: upgrade to `^0.5.0` and remove dependencies that are now transitive.
1212

13-
### What changed in 0.6.0
13+
### What changed in 0.5.0
1414

1515
These libs moved from `peerDependencies` to regular `dependencies` inside `@open-elements/ui`. Consumers no longer need to declare them — they install transitively:
1616

@@ -32,7 +32,7 @@ These remain `peerDependencies` and must stay in the consumer's `package.json`:
3232

3333
1. **Find the consumer's frontend package.json.** Usually `package.json` at repo root or under `frontend/`. Confirm `@open-elements/ui` is listed.
3434

35-
2. **Bump `@open-elements/ui` to `^0.6.0`** in that `package.json`.
35+
2. **Bump `@open-elements/ui` to `^0.5.0`** in that `package.json`.
3636

3737
3. **For each of the 11 libs above, grep the source directory for direct imports** (typically `src/`, exclude `node_modules` and `dist`):
3838

@@ -56,7 +56,7 @@ These remain `peerDependencies` and must stay in the consumer's `package.json`:
5656
grep -rln "declare module \"@tiptap/core\"" src
5757
```
5858

59-
If a file like `src/types/tiptap-markdown.d.ts` exists AND nothing in `src/` calls `editor.storage.markdown`, the augmentation is dead — `@open-elements/ui` 0.6.0 ships its own internal augmentation. Verify:
59+
If a file like `src/types/tiptap-markdown.d.ts` exists AND nothing in `src/` calls `editor.storage.markdown`, the augmentation is dead — `@open-elements/ui` 0.5.0 ships its own internal augmentation. Verify:
6060

6161
```bash
6262
grep -rn "storage\.markdown\|storage\[\"markdown" src
@@ -79,7 +79,7 @@ These remain `peerDependencies` and must stay in the consumer's `package.json`:
7979
7. **Commit** with a clear message, e.g.:
8080

8181
```
82-
chore(deps): upgrade @open-elements/ui to 0.6.0, drop now-transitive deps
82+
chore(deps): upgrade @open-elements/ui to 0.5.0, drop now-transitive deps
8383
8484
<list the deps you removed>
8585
```

0 commit comments

Comments
 (0)