From 31d9771363587faa1ccfa5f8c8833fddfb365971 Mon Sep 17 00:00:00 2001 From: David Goss Date: Tue, 2 Jun 2026 08:54:27 +0100 Subject: [PATCH] Publish TypeDoc site on release only --- .github/workflows/{site.yml => release-site.yml} | 5 ++--- .github/workflows/test.yml | 13 +++++++++++++ typedoc.json | 1 + 3 files changed, 16 insertions(+), 3 deletions(-) rename .github/workflows/{site.yml => release-site.yml} (95%) diff --git a/.github/workflows/site.yml b/.github/workflows/release-site.yml similarity index 95% rename from .github/workflows/site.yml rename to .github/workflows/release-site.yml index 21286d7..408f4b6 100644 --- a/.github/workflows/site.yml +++ b/.github/workflows/release-site.yml @@ -1,11 +1,10 @@ -name: Site +name: Release Site permissions: {} on: push: - branches: - - main + branches: [release/*] jobs: upload-artifact: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 00a6180..d5e4a3d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -62,3 +62,16 @@ jobs: - run: npm ci - run: npm run build - run: npm run exports:check + + docs: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + with: + node-version: 24.x + - run: npm ci + - run: npm run docs diff --git a/typedoc.json b/typedoc.json index 0a41663..c0f59c2 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,6 @@ { "entryPoints": ["src/index.ts"], + "includeVersion": true, "navigationLinks": { "GitHub": "https://github.com/cucumber/javascript-core" },