Skip to content

Commit bc79686

Browse files
committed
docs: adoption rules for releasing adapted plugins and rolling them out to live demo AdminForth/2005
1 parent ac619fa commit bc79686

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

‎adminforth/design/adoption.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Which packages follow the [design concepts](./system-concepts.md): tokens instead of palette colors, AFCL components, Lucide icons, no flowbite. Put ✓ only when the whole package is done and checked in light and dark theme.
44

5-
Moving a plugin to the design system makes it depend on adminforth 4 (AFCL components and Lucide icons ship with it), so apps on adminforth 3 must not get it with an update: set `peerDependencies.adminforth` to `^4.0.0` and commit with a `BREAKING CHANGE:` footer, semantic-release then publishes a new major (it ignores `feat!:`). Bump `devDependencies.adminforth` together with the lockfile once 4.0.0 is on npm, earlier `pnpm install --frozen-lockfile` fails on CI.
6-
75
| Package | Done |
86
|---|---|
97
| adminforth (core) | |
@@ -41,6 +39,11 @@ Moving a plugin to the design system makes it depend on adminforth 4 (AFCL compo
4139
| @adminforth/user-sessions | |
4240
| @adminforth/user-soft-delete | |
4341

42+
## Releasing an adapted plugin
43+
44+
- Moving a plugin to the design system makes it depend on adminforth 4 (AFCL components and Lucide icons ship with it), so apps on adminforth 3 must not get it with an update: set `peerDependencies.adminforth` to `^4.0.0` and commit with a `BREAKING CHANGE:` footer, semantic-release then publishes a new major (it ignores `feat!:`). Bump `devDependencies.adminforth` together with the lockfile once 4.0.0 is on npm, earlier `pnpm install --frozen-lockfile` fails on CI.
45+
- Roll the release out to the live demo right away: bump the plugin (and `adminforth`, when the plugin needs a newer core) in `live-demo/app/package.json` and push to `main`, the push rebuilds demo.adminforth.dev.
46+
4447
## Left in core
4548

4649
- `afcl/Tooltip.vue` uses the flowbite `Tooltip`, `afcl/DatePicker.vue` and `components/CustomDateRangePicker.vue` use `flowbite-datepicker`.

0 commit comments

Comments
 (0)