Skip to content

Commit 5c51e53

Browse files
committed
chore: update documentation and code references for version 4
- Changed import paths for defineCustomElements in multiple files to use the new loader path. - Updated links in documentation to point to the new version 4 (next) site. - Modified version hints in the documentation to reflect the new versioning. - Adjusted Angular adapter versions in the framework documentation. - Removed references to the old KoliBri Designer and updated theming instructions to reflect new practices. - Updated package.json to reflect new version numbers and dependencies. - Changed sample app links to point to the development version.
1 parent c52c19e commit 5c51e53

File tree

35 files changed

+1057
-1146
lines changed

35 files changed

+1057
-1146
lines changed
Lines changed: 28 additions & 60 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,100 +11,68 @@ 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

22-
- name: Download Docs (v2)
25+
- name: Download Docs (v3)
2326
env:
24-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
27+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
2528
shell: bash
2629
run: |
30+
npm pack @public-ui/docs-v3@latest > /dev/null
31+
tar -xzvf public-ui-*.tgz > /dev/null
32+
33+
mv package/build build
34+
mv next build/next
35+
2736
rm -rf package *.tgz
37+
38+
- name: Download Docs (v2)
39+
env:
40+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
41+
shell: bash
42+
run: |
2843
npm pack @public-ui/docs-v2@latest > /dev/null
29-
tar -xzvf public-ui-docs-*.tgz > /dev/null
44+
tar -xzvf public-ui-*.tgz > /dev/null
3045
31-
rm -rf build/docs/2.2 build/v2
46+
rm -rf build/v2
3247
mkdir -p build/v2
3348
mv package/build/* build/v2/
3449
3550
rm -rf package *.tgz
3651
3752
- name: Download designer (v1)
3853
env:
39-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
54+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
4055
shell: bash
4156
run: |
42-
rm -rf package *.tgz
4357
npm pack @public-ui/designer@^1
44-
tar -xzvf public-ui-designer-*.tgz
58+
tar -xzvf public-ui-*.tgz > /dev/null
4559
4660
rm -rf build/v1/designer
4761
mkdir -p build/v1
4862
mv package/dist build/v1/designer
4963
5064
rm -rf package *.tgz
5165
52-
- name: Download sample react (v1)
53-
env:
54-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
55-
shell: bash
56-
run: |
57-
rm -rf package *.tgz
58-
npm pack @public-ui/sample-react@^1
59-
tar -xzvf public-ui-sample-react-*.tgz
60-
61-
rm -rf build/v1/sample-react
62-
mkdir -p build/v1
63-
mv package/dist build/v1/sample-react
64-
65-
rm -rf package *.tgz
66-
6766
- name: Download designer (v2)
6867
env:
69-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
68+
NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
7069
shell: bash
7170
run: |
72-
rm -rf package *.tgz
7371
npm pack @public-ui/designer@^2
74-
tar -xzvf public-ui-designer-*.tgz
72+
tar -xzvf public-ui-*.tgz > /dev/null
7573
7674
rm -rf build/v2/designer
7775
mkdir -p build/v2
7876
mv package/dist build/v2/designer
7977
8078
rm -rf package *.tgz
81-
82-
- name: Download sample react (v2)
83-
env:
84-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
85-
shell: bash
86-
run: |
87-
rm -rf package *.tgz
88-
npm pack @public-ui/sample-react@^2
89-
tar -xzvf public-ui-sample-react-*.tgz
90-
91-
rm -rf build/v2/sample-react
92-
mkdir -p build/v2
93-
mv package/dist build/v2/sample-react
94-
95-
rm -rf package *.tgz
96-
97-
- name: Download sample react (v3)
98-
env:
99-
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
100-
shell: bash
101-
run: |
102-
rm -rf package *.tgz
103-
npm pack @public-ui/sample-react@">=3.0.0-rc.1" --include-prerelease
104-
tar -xzvf public-ui-sample-react-*.tgz
105-
106-
rm -rf build/v3/sample-react
107-
mkdir -p build/v3
108-
mv package/dist build/v3/sample-react
109-
110-
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/add-issues-to-project.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ permissions:
1515
contents: read
1616
issues: write
1717

18+
concurrency:
19+
group: 'workflow-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}'
20+
cancel-in-progress: true
21+
1822
jobs:
1923
add-to-project:
2024
name: Add issue to roadmap project

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ permissions:
1212
contents: write
1313
pull-requests: write
1414

15+
concurrency:
16+
group: 'workflow-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}'
17+
cancel-in-progress: true
18+
1519
jobs:
1620
update:
1721
runs-on: ubuntu-latest
@@ -26,7 +30,7 @@ jobs:
2630
env:
2731
version: ${{ matrix.version }}
2832
steps:
29-
- uses: actions/checkout@v5
33+
- uses: actions/checkout@v6
3034
with:
3135
fetch-depth: 0
3236
ref: ${{ matrix.base }}

.github/workflows/ci.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@ on:
44
pull_request:
55
workflow_dispatch:
66

7+
concurrency:
8+
group: 'workflow-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}'
9+
cancel-in-progress: true
10+
711
jobs:
812
build-and-check:
913
runs-on: ubuntu-latest
1014
steps:
11-
- uses: actions/checkout@v5
15+
- uses: actions/checkout@v6
1216
with:
1317
fetch-depth: 0
1418
persist-credentials: false

.github/workflows/draft-deploy.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,22 @@ on:
44
workflow_dispatch:
55
pull_request:
66

7+
concurrency:
8+
group: 'workflow-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}'
9+
cancel-in-progress: true
10+
711
jobs:
812
build-and-deploy:
913
if: ${{ github.event.pull_request.base.repo.clone_url == github.event.pull_request.head.repo.clone_url }}
1014
runs-on: ubuntu-latest
1115
steps:
1216
- name: Checkout
13-
uses: actions/checkout@v5
17+
uses: actions/checkout@v6
1418

1519
- name: Build Artifacts
1620
uses: ./.github/actions/build-artifacts
1721
with:
18-
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1923

2024
- name: Netlify Deploy
2125
uses: netlify/actions/cli@master

.github/workflows/publish.yml

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

.github/workflows/test-deploy.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@ on:
66
- 'main'
77
workflow_dispatch:
88

9+
concurrency:
10+
group: 'workflow-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}'
11+
cancel-in-progress: true
12+
913
jobs:
1014
build-and-deploy:
1115
runs-on: ubuntu-latest
1216
steps:
1317
- name: Checkout
14-
uses: actions/checkout@v5
18+
uses: actions/checkout@v6
1519

1620
- name: Build Artifacts
1721
uses: ./.github/actions/build-artifacts
1822
with:
19-
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2024

2125
- name: Netlify Deploy
2226
uses: netlify/actions/cli@master

0 commit comments

Comments
 (0)