Skip to content

Commit a968efd

Browse files
deleoniodeleonio
committed
chore: update documentation and components for version 4
- Updated Angular adapter versions in the documentation to reflect v19, v20, and v21. - Removed references to the KoliBri Designer and updated theme creation instructions to be code-based. - Adjusted import paths for defineCustomElements to use the new loader structure. - Updated package.json to reflect version changes and dependency updates. - Changed version hints in the documentation to indicate the transition from v3 to v4. - Modified sample components to include button types for better clarity.
1 parent c52c19e commit a968efd

File tree

27 files changed

+1039
-1085
lines changed

27 files changed

+1039
-1085
lines changed

‎.github/actions/build-artifacts/action.yml‎

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Build Docs Artifacts
22
description: Builds the documentation artifacts including Docusaus, Sample App and Designer
33
inputs:
4-
PERSONAL_ACCESS_TOKEN:
5-
description: 'A Github PAT'
4+
GITHUB_TOKEN:
5+
description: 'GitHub token for package registry authentication'
66
required: true
77
runs:
88
using: 'composite'
@@ -11,32 +11,51 @@ runs:
1111

1212
- name: Build Docs
1313
shell: bash
14-
run: npm run build
14+
run: |
15+
rm -rf build
16+
npm run build
17+
mv build next
1518
16-
- uses: actions/setup-node@v4
19+
- uses: actions/setup-node@v6
1720
with:
1821
node-version: 22
19-
registry-url: 'https://npm.pkg.github.com'
22+
registry-url: https://npm.pkg.github.com
2023
scope: '@public-ui'
2124

25+
- name: Download Docs (v3)
26+
env:
27+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
28+
shell: bash
29+
run: |
30+
rm -rf package *.tgz
31+
npm pack @public-ui/docs-v3@latest > /dev/null
32+
tar -xzvf public-ui-docs-*.tgz > /dev/null
33+
ls -la
34+
35+
rm -rf build
36+
mv package/build build
37+
mv next build/next
38+
39+
rm -rf package *.tgz
40+
2241
- name: Download Docs (v2)
2342
env:
24-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
43+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
2544
shell: bash
2645
run: |
2746
rm -rf package *.tgz
2847
npm pack @public-ui/docs-v2@latest > /dev/null
2948
tar -xzvf public-ui-docs-*.tgz > /dev/null
3049
31-
rm -rf build/docs/2.2 build/v2
50+
rm -rf build/v2
3251
mkdir -p build/v2
3352
mv package/build/* build/v2/
3453
3554
rm -rf package *.tgz
3655
3756
- name: Download designer (v1)
3857
env:
39-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
58+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
4059
shell: bash
4160
run: |
4261
rm -rf package *.tgz
@@ -51,7 +70,7 @@ runs:
5170
5271
- name: Download sample react (v1)
5372
env:
54-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
73+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
5574
shell: bash
5675
run: |
5776
rm -rf package *.tgz
@@ -66,7 +85,7 @@ runs:
6685
6786
- name: Download designer (v2)
6887
env:
69-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
88+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
7089
shell: bash
7190
run: |
7291
rm -rf package *.tgz
@@ -81,11 +100,11 @@ runs:
81100
82101
- name: Download sample react (v2)
83102
env:
84-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
103+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
85104
shell: bash
86105
run: |
87106
rm -rf package *.tgz
88-
npm pack @public-ui/sample-react@^2
107+
npm pack @public-ui/sample-react@^2 --include-prerelease
89108
tar -xzvf public-ui-sample-react-*.tgz
90109
91110
rm -rf build/v2/sample-react
@@ -96,15 +115,30 @@ runs:
96115
97116
- name: Download sample react (v3)
98117
env:
99-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
118+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
100119
shell: bash
101120
run: |
102121
rm -rf package *.tgz
103-
npm pack @public-ui/sample-react@">=3.0.0-rc.1" --include-prerelease
122+
npm pack @public-ui/sample-react@^3 --include-prerelease
104123
tar -xzvf public-ui-sample-react-*.tgz
105124
106-
rm -rf build/v3/sample-react
107-
mkdir -p build/v3
108-
mv package/dist build/v3/sample-react
125+
rm -rf build/sample-react
126+
mkdir -p build
127+
mv package/dist build/sample-react
109128
110129
rm -rf package *.tgz
130+
131+
# - name: Download sample react (v4)
132+
# env:
133+
# NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
134+
# shell: bash
135+
# run: |
136+
# rm -rf package *.tgz
137+
# npm pack @public-ui/sample-react@^4 --include-prerelease
138+
# tar -xzvf public-ui-sample-react-*.tgz
139+
140+
# rm -rf build/next/sample-react
141+
# mkdir -p build/next
142+
# mv package/dist build/next/sample-react
143+
144+
# rm -rf package *.tgz

‎.github/actions/pnpm-setup/action.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
name: pnpm Setup
66
description: Install Node and pnpm, install dependencies
77
runs:
8-
using: 'composite'
8+
using: composite
99
steps:
1010
- uses: pnpm/action-setup@v4
1111
with:
1212
version: 10
1313
run_install: false
1414

15-
- uses: actions/setup-node@v4
15+
- uses: actions/setup-node@v6
1616
with:
17-
node-version: '22'
18-
cache: 'pnpm'
17+
node-version: 22
18+
cache: pnpm
1919

2020
- run: pnpm install
2121
shell: bash

‎.github/dependabot.yml‎

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,41 @@
55

66
version: 2
77
updates:
8+
# === Default Branch ===
89
- package-ecosystem: github-actions
9-
directory: "/"
10+
directory: /
11+
labels:
12+
- dependabot
13+
- v4
1014
schedule:
11-
interval: monthly
12-
target-branch: main
13-
# - package-ecosystem: npm
14-
# directory: "/dev"
15-
# ignore:
16-
# - dependency-name: "rimraf"
17-
# schedule:
18-
# interval: daily
19-
# target-branch: main
15+
interval: weekly
16+
17+
# === Release Branch: v3 ===
18+
- package-ecosystem: github-actions
19+
directory: /
20+
target-branch: release/3
21+
labels:
22+
- dependabot
23+
- v3
24+
schedule:
25+
interval: weekly
26+
27+
# === Release Branch: v2 ===
28+
- package-ecosystem: github-actions
29+
directory: /
30+
target-branch: release/2
31+
labels:
32+
- dependabot
33+
- v2
34+
schedule:
35+
interval: weekly
36+
37+
# === Release Branch: v1 ===
38+
- package-ecosystem: github-actions
39+
directory: /
40+
target-branch: release/1
41+
labels:
42+
- dependabot
43+
- v1
44+
schedule:
45+
interval: weekly

‎.github/workflows/auto-dependency-updater.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
env:
2727
version: ${{ matrix.version }}
2828
steps:
29-
- uses: actions/checkout@v5
29+
- uses: actions/checkout@v6
3030
with:
3131
fetch-depth: 0
3232
ref: ${{ matrix.base }}

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
build-and-check:
99
runs-on: ubuntu-latest
1010
steps:
11-
- uses: actions/checkout@v5
11+
- uses: actions/checkout@v6
1212
with:
1313
fetch-depth: 0
1414
persist-credentials: false

‎.github/workflows/draft-deploy.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- name: Checkout
13-
uses: actions/checkout@v5
13+
uses: actions/checkout@v6
1414

1515
- name: Build Artifacts
1616
uses: ./.github/actions/build-artifacts
1717
with:
18-
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
18+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1919

2020
- name: Netlify Deploy
2121
uses: netlify/actions/cli@master

‎.github/workflows/publish.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Publish GitHub package and trigger main branch update
2+
3+
on:
4+
push:
5+
branches:
6+
- release/3
7+
workflow_dispatch:
8+
9+
jobs:
10+
publish:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
packages: write
15+
steps:
16+
- uses: actions/create-github-app-token@v2
17+
id: app-token
18+
with:
19+
app-id: ${{ secrets.APP_ID }}
20+
private-key: ${{ secrets.PRIVATE_KEY }}
21+
22+
- name: Get GitHub App User ID
23+
id: get-user-id
24+
run: echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
25+
env:
26+
GH_TOKEN: ${{ steps.app-token.outputs.token }}
27+
28+
- name: Checkout
29+
uses: actions/checkout@v5
30+
with:
31+
token: ${{ steps.app-token.outputs.token }}
32+
fetch-depth: 0
33+
34+
- name: Build Artifacts
35+
uses: ./.github/actions/build-artifacts
36+
with:
37+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
38+
39+
- uses: actions/setup-node@v6
40+
with:
41+
node-version: 22
42+
registry-url: https://npm.pkg.github.com
43+
44+
- name: Bump version
45+
shell: bash
46+
run: pnpm version prerelease --no-git-tag-version
47+
48+
- name: Commit and push changes
49+
uses: stefanzweifel/git-auto-commit-action@v5
50+
with:
51+
commit_message: 'chore: Bump version [skip actions]'
52+
file_pattern: 'package.json'
53+
commit_user_name: '${{ steps.app-token.outputs.app-slug }}[bot]'
54+
commit_user_email: '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com'
55+
56+
- name: Publish Docs
57+
run: npm publish --access restricted
58+
env:
59+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
60+
61+
- name: Trigger main branch update
62+
shell: bash
63+
run: gh workflow run update.yml --ref main
64+
env:
65+
GH_TOKEN: ${{ steps.app-token.outputs.token }}

‎.github/workflows/test-deploy.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- name: Checkout
14-
uses: actions/checkout@v5
14+
uses: actions/checkout@v6
1515

1616
- name: Build Artifacts
1717
uses: ./.github/actions/build-artifacts
1818
with:
19-
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2020

2121
- name: Netlify Deploy
2222
uses: netlify/actions/cli@master

‎.github/workflows/update.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,27 @@ on:
99
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
1010
permissions:
1111
contents: read
12+
packages: read
1213
pages: write
1314
id-token: write
1415

1516
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
1617
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
1718
concurrency:
18-
group: "pages"
19+
group: 'pages'
1920
cancel-in-progress: false
2021

2122
jobs:
2223
update:
2324
runs-on: ubuntu-latest
2425
steps:
2526
- name: Checkout
26-
uses: actions/checkout@v5
27+
uses: actions/checkout@v6
2728

2829
- name: Build Artifacts
2930
uses: ./.github/actions/build-artifacts
3031
with:
31-
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
32+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3233

3334
- name: Setup Pages
3435
uses: actions/configure-pages@v5

‎docs/10-get-started/1-first-steps.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ import App from "./App.tsx";
9090
import "./index.css";
9191

9292
+import { register } from "@public-ui/components";
93-
+import { defineCustomElements } from "@public-ui/components/dist/loader";
93+
+import { defineCustomElements } from "@public-ui/components/loader";
9494
+import { DEFAULT } from "@public-ui/themes";
9595

9696
+register(DEFAULT, defineCustomElements)
@@ -156,7 +156,7 @@ kolibri.plugin.ts
156156

157157
```js
158158
import type { Plugin } from 'vue';
159-
import { defineCustomElements } from '@public-ui/components/dist/loader';
159+
import { defineCustomElements } from '@public-ui/components/loader';
160160
import { register } from '@public-ui/components';
161161
import { DEFAULT } from '@public-ui/theme-default';
162162
export const ComponentLibrary: Plugin = {
@@ -274,7 +274,7 @@ import ReactDOM from 'react-dom';
274274
import { AppComponent } from './components/app/component';
275275

276276
import { register } from '@public-ui/core';
277-
import { defineCustomElements } from '@public-ui/components/dist/loader';
277+
import { defineCustomElements } from '@public-ui/components/loader';
278278
import { DEFAULT } from '@public-ui/themes';
279279

280280
register(DEFAULT, defineCustomElements)
@@ -346,7 +346,7 @@ Sofern Schriftarten und/oder Icons verwendet werden, müssen diese, wie oben bes
346346
```html
347347
<script type="module">
348348
import { register } from 'https://unpkg.com/@public-ui/components/dist/esm/index.js';
349-
import { defineCustomElements } from 'https://unpkg.com/@public-ui/components/dist/loader/index.js';
349+
import { defineCustomElements } from 'https://unpkg.com/@public-ui/components/loader/index.js';
350350
import { DEFAULT } from 'https://unpkg.com/@public-ui/theme-default/dist/index.mjs';
351351
register(DEFAULT, defineCustomElements).catch(console.warn);
352352
</script>

0 commit comments

Comments
 (0)