From ac27c9fa6013d1fc51e7779e6f18d77df180c589 Mon Sep 17 00:00:00 2001 From: Tobey Blaber Date: Wed, 24 Aug 2022 14:25:02 +0100 Subject: [PATCH 1/2] Implement `typedoc-plugin-versions` --- .github/workflows/publish-docs.yml | 14 ++++- package-lock.json | 88 ++++++++++++++++++++++++++++++ package.json | 1 + typedoc.json | 5 +- 4 files changed, 104 insertions(+), 4 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 08dba08..7ddf2d8 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -9,9 +9,20 @@ jobs: deploy-docs: runs-on: ubuntu-latest steps: - - name: Checkout repository + - name: Checkout main uses: actions/checkout@v3 + - name: Checkout gh-pages + uses: actions/checkout@v3 + with: + ref: gh-pages + path: "./gh-pages" + + - name: Fix folder structure + run: | + mv gh-pages/docs docs + rm -rf gh-pages + - name: Setup node.js @ 16 uses: actions/setup-node@v3 with: @@ -52,3 +63,4 @@ jobs: uses: JamesIves/github-pages-deploy-action@v4 with: folder: docs + target-folder: docs diff --git a/package-lock.json b/package-lock.json index 1b3fb91..6b54c79 100644 --- a/package-lock.json +++ b/package-lock.json @@ -33,6 +33,7 @@ "ts-jest": "^28.0.8", "typed-emitter": "^2.1.0", "typedoc": "^0.23.10", + "typedoc-plugin-versions": "^0.1.0", "typescript": "^4.7.4" }, "engines": { @@ -2598,6 +2599,20 @@ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==", "dev": true }, + "node_modules/fs-extra": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=12" + } + }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -3633,6 +3648,18 @@ "integrity": "sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==", "dev": true }, + "node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -4820,6 +4847,22 @@ "typescript": "4.6.x || 4.7.x" } }, + "node_modules/typedoc-plugin-versions": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-versions/-/typedoc-plugin-versions-0.1.0.tgz", + "integrity": "sha512-KsKqFxEZVbxBoRJCPIQjUQadI31dAVN/cW32vl0U8RqxNVDiEtR6cjTZgVeuOh7G1+Ei6D5L0LgWiUl8w+HRlA==", + "dev": true, + "dependencies": { + "fs-extra": "^10.1.0" + }, + "engines": { + "node": ">=14.0.0", + "npm": ">=6.0.0" + }, + "peerDependencies": { + "typedoc": "^0.23" + } + }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -4854,6 +4897,15 @@ "node": ">=4.2.0" } }, + "node_modules/universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "dev": true, + "engines": { + "node": ">= 10.0.0" + } + }, "node_modules/update-browserslist-db": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.5.tgz", @@ -7021,6 +7073,17 @@ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==", "dev": true }, + "fs-extra": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + } + }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -7799,6 +7862,16 @@ "integrity": "sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==", "dev": true }, + "jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6", + "universalify": "^2.0.0" + } + }, "kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -8654,12 +8727,27 @@ } } }, + "typedoc-plugin-versions": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-versions/-/typedoc-plugin-versions-0.1.0.tgz", + "integrity": "sha512-KsKqFxEZVbxBoRJCPIQjUQadI31dAVN/cW32vl0U8RqxNVDiEtR6cjTZgVeuOh7G1+Ei6D5L0LgWiUl8w+HRlA==", + "dev": true, + "requires": { + "fs-extra": "^10.1.0" + } + }, "typescript": { "version": "4.7.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz", "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==", "dev": true }, + "universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "dev": true + }, "update-browserslist-db": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.5.tgz", diff --git a/package.json b/package.json index 9bc2f68..4674ce8 100644 --- a/package.json +++ b/package.json @@ -47,6 +47,7 @@ "ts-jest": "^28.0.8", "typed-emitter": "^2.1.0", "typedoc": "^0.23.10", + "typedoc-plugin-versions": "^0.1.0", "typescript": "^4.7.4" }, "files": [ diff --git a/typedoc.json b/typedoc.json index 0c6dab6..f5ec8c0 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,5 @@ { - "exclude": "**/*+(.spec|.test).ts", "entryPoints": "src", - "out": "docs", - "entryPointStrategy": "expand" + "entryPointStrategy": "expand", + "includeVersion": "true" } From 224190a6717b533b2134f545a70a04f68e87bb92 Mon Sep 17 00:00:00 2001 From: Tobey Blaber Date: Wed, 24 Aug 2022 14:37:08 +0100 Subject: [PATCH 2/2] Remove redundant build from --- .github/workflows/publish-docs.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 7ddf2d8..34014e3 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -53,9 +53,6 @@ jobs: - name: Install dependencies run: npm ci - - name: Check build compiles - run: npm run build - - name: Generate API reference run: npm run docs