From 6bd2a4b4acd7dd445dedd94dafcd06c69e8fdb05 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:10:56 +0100 Subject: [PATCH 01/18] mkdocs likec4 dependencies --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 278d0ff..8082663 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,7 @@ site_name: Crate Validation Service +plugins: + - search + - likec4 nav: - Home: index.md - Installation: installation.md From 473a5625544a57be060b93c3b843b2b2f9f0cea7 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:11:23 +0100 Subject: [PATCH 02/18] example likec4 inclusion --- docs/installation.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/installation.md b/docs/installation.md index c8f3f52..1874c84 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,9 @@ # Installation +```likec4-view +ro-crate_service +``` + ## Service Snapshot Cratey Validator is a web service that checks whether RO-Crates follow the From d03ea4793ed7c9201c6495efb3a58384e727abc0 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:20:18 +0100 Subject: [PATCH 03/18] ignore npm module dir --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 318044e..0f8b44d 100644 --- a/.gitignore +++ b/.gitignore @@ -319,3 +319,4 @@ cython_debug/ /cache-directory/ data .vscode +node_modules From e7475d333ab69c8becde626a1a048368b0adebc6 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:30:49 +0100 Subject: [PATCH 04/18] template deploy pages workflow --- .github/workflows/deploy-pages.yml | 62 ++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 .github/workflows/deploy-pages.yml diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml new file mode 100644 index 0000000..bf01433 --- /dev/null +++ b/.github/workflows/deploy-pages.yml @@ -0,0 +1,62 @@ +# Sample workflow for building and deploying a website to GitHub Pages +name: Deploy Pages + +on: + # Runs on pushes targeting the default branch and c4 files + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_call: + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +#permissions: +# contents: read +# pages: write +# id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in progress and the latest queued. +# However, do NOT cancel in-progress runs, as we want to allow these production deployments to be completed. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build-pages: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v5 + + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + + - name: Build + uses: likec4/actions@v1 + with: + action: build + output: dist + # required if you don't set a custom domain for the repository + # https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites + base: ${{ steps.pages.outputs.base_path }} + likec4-version: latest + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./dist + + # Deployment job + #deploy-pages: + # environment: + # name: github-pages + # url: ${{ steps.deployment.outputs.page_url }} + # runs-on: ubuntu-latest + # needs: build-pages + # steps: + # - name: Deploy to GitHub Pages + # id: deployment + # uses: actions/deploy-pages@v4 \ No newline at end of file From 1f0783b81ea4150db39057762c23b9e701087e52 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:41:49 +0100 Subject: [PATCH 05/18] build on pr for now --- .github/workflows/deploy-pages.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index bf01433..a1048fb 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -3,9 +3,9 @@ name: Deploy Pages on: # Runs on pushes targeting the default branch and c4 files - push: - branches: ["main"] - + pull_request: + branches: [ develop ] + # Allows you to run this workflow manually from the Actions tab workflow_call: workflow_dispatch: From 78ab5f18d19594831516605ed27d491cf73b7874 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:49:47 +0100 Subject: [PATCH 06/18] combine mkdocs plugins lists --- .github/workflows/deploy-pages.yml | 3 +-- mkdocs.yml | 4 +--- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index a1048fb..e7fac19 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -4,8 +4,7 @@ name: Deploy Pages on: # Runs on pushes targeting the default branch and c4 files pull_request: - branches: [ develop ] - + # Allows you to run this workflow manually from the Actions tab workflow_call: workflow_dispatch: diff --git a/mkdocs.yml b/mkdocs.yml index a9013d0..8152e71 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,4 @@ site_name: Crate Validation Service -plugins: - - search - - likec4 nav: - Home: index.md - Installation: installation.md @@ -12,5 +9,6 @@ theme: readthedocs plugins: - search - mermaid2 + - likec4 markdown_extensions: - admonition From 7248e708996f22fc85ccf23afa138bf21bbdf14f Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:57:04 +0100 Subject: [PATCH 07/18] adjust likec4 build base dir --- .github/workflows/deploy-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index e7fac19..b29be89 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -40,7 +40,7 @@ jobs: output: dist # required if you don't set a custom domain for the repository # https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites - base: ${{ steps.pages.outputs.base_path }} + base: ${{ steps.pages.outputs.base_path }}/docs/c4_diagrams/likec4_src likec4-version: latest - name: Upload artifact From 6cfdaf37dd57e9e88797b9bed8c6ed0a260e0384 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:25:07 +0100 Subject: [PATCH 08/18] switch to bun workflow --- .github/workflows/deploy-pages.yml | 38 +++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index b29be89..5a77725 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -22,26 +22,48 @@ concurrency: cancel-in-progress: false jobs: + # Validate model following our rules + # @see test/validate-model.spec.ts + validate: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v5 + + - name: Setup bun + uses: oven-sh/setup-bun@v2 + + - name: Install dependencies + run: bun install + + - name: Validate + run: bun run test + # Build job build-pages: runs-on: ubuntu-latest + needs: validate steps: - name: Checkout uses: actions/checkout@v5 + - name: Setup bun + uses: oven-sh/setup-bun@v2 + - name: Setup Pages id: pages uses: actions/configure-pages@v4 - - name: Build - uses: likec4/actions@v1 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 with: - action: build - output: dist - # required if you don't set a custom domain for the repository - # https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites - base: ${{ steps.pages.outputs.base_path }}/docs/c4_diagrams/likec4_src - likec4-version: latest + path: ./dist + + - name: Build + run: | + bunx likec4@latest build \ + --base "${{ steps.pages.outputs.base_path || '/' }}" \ + --output dist - name: Upload artifact uses: actions/upload-pages-artifact@v3 From c395033d071ddcbd75d90ece6603c29877299300 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:33:31 +0100 Subject: [PATCH 09/18] mkdocs deps for likec4 --- docs/package.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/package.json diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..a847785 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "likec4": "^1.59.2" + } +} From f3aa341532369d4eea6d89e8b1cbef7c7c0b8ab8 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:34:21 +0100 Subject: [PATCH 10/18] filter for bun packages for docs deploy --- .github/workflows/deploy-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 5a77725..5243eed 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -34,7 +34,7 @@ jobs: uses: oven-sh/setup-bun@v2 - name: Install dependencies - run: bun install + run: bun install --filter 'docs/*' - name: Validate run: bun run test From 58df63b1a111b23adaed2784ecd63b3047123ce0 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:36:37 +0100 Subject: [PATCH 11/18] package file path made relative --- .github/workflows/deploy-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 5243eed..e70d9c9 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -34,7 +34,7 @@ jobs: uses: oven-sh/setup-bun@v2 - name: Install dependencies - run: bun install --filter 'docs/*' + run: bun install --filter './docs/*' - name: Validate run: bun run test From 4ad05fa3b4229f0b42cf08a7f52719ad746bce5a Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:39:37 +0100 Subject: [PATCH 12/18] package file path directory only --- .github/workflows/deploy-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index e70d9c9..90dc66b 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -34,7 +34,7 @@ jobs: uses: oven-sh/setup-bun@v2 - name: Install dependencies - run: bun install --filter './docs/*' + run: bun install --filter './docs' - name: Validate run: bun run test From a04e0716bd5549de098d2cc78ac72fc4b58bb9c3 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:41:01 +0100 Subject: [PATCH 13/18] check docs contents --- .github/workflows/deploy-pages.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 90dc66b..003a492 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -34,6 +34,7 @@ jobs: uses: oven-sh/setup-bun@v2 - name: Install dependencies + run: ls ./docs run: bun install --filter './docs' - name: Validate From e275cacf8cec66e2c51ff98f84d705599e30a996 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:53:29 +0100 Subject: [PATCH 14/18] Revert "check docs contents" This reverts commit a04e0716bd5549de098d2cc78ac72fc4b58bb9c3. --- .github/workflows/deploy-pages.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 003a492..90dc66b 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -34,7 +34,6 @@ jobs: uses: oven-sh/setup-bun@v2 - name: Install dependencies - run: ls ./docs run: bun install --filter './docs' - name: Validate From 68182c5f4b0044cf7f0e3c93e3634cf767af35a2 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:54:13 +0100 Subject: [PATCH 15/18] move npm package file to base directory --- docs/package.json => package.json | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/package.json => package.json (100%) diff --git a/docs/package.json b/package.json similarity index 100% rename from docs/package.json rename to package.json From c1330d717a9c6f62dc684e06910dcb6a21844eee Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:55:09 +0100 Subject: [PATCH 16/18] remove bun filter --- .github/workflows/deploy-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 90dc66b..5a77725 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -34,7 +34,7 @@ jobs: uses: oven-sh/setup-bun@v2 - name: Install dependencies - run: bun install --filter './docs' + run: bun install - name: Validate run: bun run test From 22e6897b43c2ef33fc99410e4c9045e04ca61577 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 14:18:10 +0100 Subject: [PATCH 17/18] remove test step from workflow --- .github/workflows/deploy-pages.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 5a77725..3e773aa 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -36,8 +36,8 @@ jobs: - name: Install dependencies run: bun install - - name: Validate - run: bun run test + #- name: Validate + # run: bun run test # Build job build-pages: From 14e4b2cc591ad4b263624be9690ed8df68370448 Mon Sep 17 00:00:00 2001 From: Douglas Lowe <10961945+douglowe@users.noreply.github.com> Date: Thu, 23 Jul 2026 14:23:23 +0100 Subject: [PATCH 18/18] change to docs base --- .github/workflows/deploy-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 3e773aa..2419a85 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -62,7 +62,7 @@ jobs: - name: Build run: | bunx likec4@latest build \ - --base "${{ steps.pages.outputs.base_path || '/' }}" \ + --base "${{ steps.pages.outputs.base_path || '/docs' }}" \ --output dist - name: Upload artifact