From 6be25b2ed0868ee6ecd6326a27130f2ef15b1099 Mon Sep 17 00:00:00 2001 From: Ben Polinsky <78756012+ben-polinsky@users.noreply.github.com> Date: Tue, 10 Dec 2024 09:29:38 -0500 Subject: [PATCH 1/2] Docs: workaround for typedoc issue #2802 (#7470) Co-authored-by: Ben Polinsky (cherry picked from commit 906f63a8b6c8d4c29356d68efeb0b826a9a14e9f) # Conflicts: # common/config/azure-pipelines/jobs/docs-build.yaml --- ...s-residual-typedoc0.26-issues_2024-12-09-20-45.json | 10 ++++++++++ common/config/azure-pipelines/jobs/docs-build.yaml | 6 ++++-- tools/build/scripts/docs.js | 4 +++- 3 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 common/changes/@itwin/build-tools/docs-residual-typedoc0.26-issues_2024-12-09-20-45.json diff --git a/common/changes/@itwin/build-tools/docs-residual-typedoc0.26-issues_2024-12-09-20-45.json b/common/changes/@itwin/build-tools/docs-residual-typedoc0.26-issues_2024-12-09-20-45.json new file mode 100644 index 000000000000..35444805da29 --- /dev/null +++ b/common/changes/@itwin/build-tools/docs-residual-typedoc0.26-issues_2024-12-09-20-45.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@itwin/build-tools", + "comment": "add temporary fix for typedoc@0.26 issue #2802", + "type": "none" + } + ], + "packageName": "@itwin/build-tools" +} \ No newline at end of file diff --git a/common/config/azure-pipelines/jobs/docs-build.yaml b/common/config/azure-pipelines/jobs/docs-build.yaml index 3079f4ee4fc8..e2abc0b320f7 100644 --- a/common/config/azure-pipelines/jobs/docs-build.yaml +++ b/common/config/azure-pipelines/jobs/docs-build.yaml @@ -45,8 +45,6 @@ parameters: type: boolean default: false - - jobs: - job: DocsBuild displayName: Docs Build @@ -117,7 +115,11 @@ jobs: useCurrentConnectorFrameworkDocsArtifact: ${{ parameters.useCurrentConnectorFrameworkDocsArtifact }} # Currently BeMetalsmith is an internal only tool +<<<<<<< HEAD - script: npm install @bentley/bemetalsmith@5.3.x +======= + - script: npm install @bentley/bemetalsmith@5.5.x +>>>>>>> 906f63a8b6c (Docs: workaround for typedoc issue #2802 (#7470)) displayName: Install BeMetalsmith workingDirectory: ${{ parameters.workingDir }} diff --git a/tools/build/scripts/docs.js b/tools/build/scripts/docs.js index 368a849c1b82..b4a6d1b9df2f 100644 --- a/tools/build/scripts/docs.js +++ b/tools/build/scripts/docs.js @@ -52,7 +52,9 @@ const readmeOption = (argv.readme === undefined) ? "none" : argv.readme; const options = [ "--hideGenerator", "--logLevel", - "Error" + "Error", + "--cascadedModifierTags", // workaround for https://github.com/TypeStrong/typedoc/issues/2802 + "@experimental" ]; const pluginOptions = [ From bddd919f901505024ca1def9a4a31cf78b9b76fa Mon Sep 17 00:00:00 2001 From: Ben Polinsky Date: Tue, 10 Dec 2024 15:47:51 -0500 Subject: [PATCH 2/2] resolve conflict --- common/config/azure-pipelines/jobs/docs-build.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/common/config/azure-pipelines/jobs/docs-build.yaml b/common/config/azure-pipelines/jobs/docs-build.yaml index e2abc0b320f7..6883d3ba86ff 100644 --- a/common/config/azure-pipelines/jobs/docs-build.yaml +++ b/common/config/azure-pipelines/jobs/docs-build.yaml @@ -95,7 +95,7 @@ jobs: - task: DownloadPipelineArtifact@2 displayName: Download Core Generated Docs Artifact inputs: - source: 'specific' + source: "specific" project: 2c48216e-e72f-48b4-a4eb-40ff1c04e8e4 pipeline: 7436 # iTwin.js Docs (docs-ci.yaml) artifact: Core Generated Docs @@ -115,11 +115,7 @@ jobs: useCurrentConnectorFrameworkDocsArtifact: ${{ parameters.useCurrentConnectorFrameworkDocsArtifact }} # Currently BeMetalsmith is an internal only tool -<<<<<<< HEAD - - script: npm install @bentley/bemetalsmith@5.3.x -======= - script: npm install @bentley/bemetalsmith@5.5.x ->>>>>>> 906f63a8b6c (Docs: workaround for typedoc issue #2802 (#7470)) displayName: Install BeMetalsmith workingDirectory: ${{ parameters.workingDir }}