Skip to content

Prepare versioned docs for v2 #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 40 commits into from
Apr 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
0efe03b
Move v2 versioned docs to general docs
sdvg Mar 27, 2025
3581d10
Remove versioned docs
sdvg Mar 27, 2025
124414d
Remove versioned readmes
sdvg Mar 27, 2025
4cc2b4b
Fix Readme import paths in docs
sdvg Mar 27, 2025
cdac2de
Remove debug output
sdvg Mar 28, 2025
a9bef55
Add archive links
sdvg Mar 28, 2025
8e15963
Replace versions service with simple constant
sdvg Mar 28, 2025
138187f
Remove blog
sdvg Mar 28, 2025
ebc2cce
Remove backup folder
sdvg Mar 28, 2025
7142bb7
Set base URL
sdvg Mar 28, 2025
1fadf29
Fix faulty HTML (nested p-tags)
sdvg Mar 29, 2025
a6d3292
Fix URLs
sdvg Mar 29, 2025
a59d715
Remove debug output
sdvg Mar 29, 2025
2ed478a
Fix links
sdvg Mar 29, 2025
b627e7e
Simplify and fix test deployment
sdvg Mar 30, 2025
f944893
Fix deploy dir
sdvg Mar 30, 2025
3f31203
Fix syntax
sdvg Mar 30, 2025
20c3741
fix package.json
sdvg Mar 30, 2025
6e8d8b8
Remove redundant quotes and adjust test-deploy as well
sdvg Mar 30, 2025
5884239
Fix linting errors / missing usages of version
sdvg Mar 31, 2025
e8ca56d
Replace public base URL
sdvg Mar 31, 2025
d650d74
Fix archive link
sdvg Mar 31, 2025
a17bceb
Remove redundant build steps
sdvg Mar 31, 2025
b1df5a3
Update branchnames
sdvg Mar 31, 2025
0875b07
Configure publish workflow
sdvg Mar 31, 2025
bb5e32d
0.0.1
sdvg Mar 31, 2025
94ab857
Add version bump step
sdvg Mar 31, 2025
0b6872f
Add dev branch for testing
sdvg Mar 31, 2025
a7e505a
Authorize git push
sdvg Mar 31, 2025
2eb861a
chore: Bump version
actions-user Mar 31, 2025
999101e
Remove private field to allow publishing
sdvg Mar 31, 2025
269f7fe
Merge remote-tracking branch 'origin/284-prepare-release-v2' into 284…
sdvg Mar 31, 2025
25503be
chore: Bump version
actions-user Mar 31, 2025
6b9fd80
Remove test branch from workflow
sdvg Mar 31, 2025
b633ae1
Remove unnecessary gen:doc dependency
sdvg Apr 1, 2025
eac32d6
Trigger main branch update workflow after npm publish
sdvg Apr 1, 2025
e4bc0a6
Implement hint for newer docs version
sdvg Apr 2, 2025
b5f96c0
Update translation files
sdvg Apr 2, 2025
bc29512
Provide en translations
sdvg Apr 2, 2025
6a07ad4
Remove label
sdvg Apr 2, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
75 changes: 2 additions & 73 deletions .github/actions/build-artifacts/action.yml
Original file line number Diff line number Diff line change
@@ -1,81 +1,10 @@
name: Build Docs Artifacts
description: Builds the documentation artifacts including Docusaus, Sample App and Designer
inputs:
PERSONAL_ACCESS_TOKEN:
description: 'A Github PAT'
required: true
description: Builds the documentation
runs:
using: "composite"
steps:
- uses: ./.github/actions/pnpm-setup

- name: Build Docs
shell: bash
run: |
pnpm install --no-frozen-lockfile
npm run build
- uses: actions/setup-node@v4
with:
node-version: 20
registry-url: "https://npm.pkg.github.com"
scope: "@public-ui"

- name: Download designer (v1)
env:
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
shell: bash
run: |
rm -rf package *.tgz
npm pack @public-ui/designer@^1
tar -xzvf public-ui-designer-*.tgz

rm -rf build/v1/designer
mkdir -p build/v1
mv package/dist build/v1/designer

rm -rf package *.tgz

- name: Download sample react (v1)
env:
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
shell: bash
run: |
rm -rf package *.tgz
npm pack @public-ui/sample-react@^1
tar -xzvf public-ui-sample-react-*.tgz

rm -rf build/v1/sample-react
mkdir -p build/v1
mv package/dist build/v1/sample-react

rm -rf package *.tgz

- name: Download designer (v2)
env:
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
shell: bash
run: |
rm -rf package *.tgz
npm pack @public-ui/designer@^2
tar -xzvf public-ui-designer-*.tgz

rm -rf build/v2/designer
mkdir -p build/v2
mv package/dist build/v2/designer

rm -rf package *.tgz

- name: Download sample react (v2)
env:
NODE_AUTH_TOKEN: ${{ inputs.PERSONAL_ACCESS_TOKEN }}
shell: bash
run: |
rm -rf package *.tgz
npm pack @public-ui/sample-react@^2
tar -xzvf public-ui-sample-react-*.tgz

rm -rf build/v2/sample-react
mkdir -p build/v2
mv package/dist build/v2/sample-react

rm -rf package *.tgz
run: npm run build
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ updates:
directory: "/"
schedule:
interval: monthly
target-branch: main
target-branch: release/2
# - package-ecosystem: npm
# directory: "/dev"
# ignore:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/auto-dependency-updater.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
with:
fetch-depth: 0
persist-credentials: false
ref: "main"
ref: "release/2"
- uses: ./.github/actions/pnpm-setup
- name: Create new branch
run: git checkout -b chore/auto-update-deps
Expand Down
12 changes: 9 additions & 3 deletions .github/workflows/draft-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Build Artifacts
- name: Build Docs
uses: ./.github/actions/build-artifacts
with:
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

- name: Move docs
shell: bash
run: |
mkdir -p dist/docs
mv build dist/docs/2.2/

- name: Netlify Deploy
uses: netlify/actions/cli@master
id: netlify
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ vars.NETLIFY_SITE_ID }}
with:
args: deploy --dir=build
args: deploy --dir=dist

- name: Find comment
uses: peter-evans/find-comment@v3
Expand All @@ -41,6 +47,6 @@ jobs:
issue-number: ${{ github.event.pull_request.number }}
body: |
Netlify Draft Deployment
URL: ${{ steps.netlify.outputs.NETLIFY_URL }}
URL: ${{ steps.netlify.outputs.NETLIFY_URL }}/docs/2.2
Logs: ${{ steps.netlify.outputs.NETLIFY_LOGS_URL }}
edit-mode: replace
50 changes: 50 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Publish GitHub package and trigger main branch update

on:
push:
branches:
- release/2
workflow_dispatch:

jobs:
publish:
permissions:
packages: write
contents: write
pull-requests: write
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Build Artifacts
uses: ./.github/actions/build-artifacts

# Publish packages on GitHub packages
- uses: actions/setup-node@v4
with:
node-version: 22
registry-url: https://npm.pkg.github.com

- name: Bump version
shell: bash
run: |
pnpm version patch --no-git-tag-version
git config user.name "GitHub Actions"
git config user.email "actions@github.com"
git add package.json
git commit -m "chore: Bump version"

- uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.ref }}

- name: Publish Docs
run: npm publish --access restricted
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Trigger main branch update
shell: bash
run: gh workflow run update.yml --ref main
14 changes: 10 additions & 4 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Netlify Test Deploy - Deploy main branch under fixed alias
name: Netlify Test Deploy - Deploy release branch under fixed alias

on:
push:
branches:
- 'main'
- 'release/2'
workflow_dispatch:

jobs:
Expand All @@ -13,16 +13,22 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Build Artifacts
- name: Build Docs
uses: ./.github/actions/build-artifacts
with:
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

- name: Move docs
shell: bash
run: |
mkdir -p dist/docs
mv build dist/docs/2.2/

- name: Netlify Deploy
uses: netlify/actions/cli@master
id: netlify
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ vars.NETLIFY_SITE_ID }}
with:
args: deploy --dir=build --alias="$GITHUB_REF_NAME"
args: deploy --dir=dist --alias="$GITHUB_REF_NAME"
43 changes: 0 additions & 43 deletions .github/workflows/update.yml

This file was deleted.

44 changes: 0 additions & 44 deletions backup/toaster/readme.md

This file was deleted.

37 changes: 0 additions & 37 deletions blog/2023-01-04.mdx

This file was deleted.

Loading
Loading