Skip to content
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

Docs: workaround for typedoc issue #2802 (backport #7470) [release/4.11.x] #7476

Merged
merged 4 commits into from
Dec 16, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Dec 10, 2024

TypeDoc 0.26 introduced a defect which caused modifier tags (@alpha, @beta, etc...) to be absent in certain type reflections - causing various issues with linking. While the bug has been identified and fixed, we need to update our docs build system to ESM (in progress) to consume the new version of TypeDoc. In the meantime, a workaround for the issue is to override the default cascadedModifierTags.


This is an automatic backport of pull request #7470 done by Mergify.

Co-authored-by: Ben Polinsky <[email protected]>
(cherry picked from commit 906f63a)

# Conflicts:
#	common/config/azure-pipelines/jobs/docs-build.yaml
@mergify mergify bot requested a review from a team as a code owner December 10, 2024 17:30
@mergify mergify bot added the conflicts label Dec 10, 2024
Copy link
Contributor Author

mergify bot commented Dec 10, 2024

Cherry-pick of 906f63a has failed:

On branch mergify/bp/release/4.11.x/pr-7470
Your branch is up to date with 'origin/release/4.11.x'.

You are currently cherry-picking commit 906f63a8b6c.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   common/changes/@itwin/build-tools/docs-residual-typedoc0.26-issues_2024-12-09-20-45.json
	modified:   tools/build/scripts/docs.js

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   common/config/azure-pipelines/jobs/docs-build.yaml

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot requested a review from a team December 10, 2024 17:31
@ben-polinsky ben-polinsky enabled auto-merge (squash) December 10, 2024 21:00
@ben-polinsky ben-polinsky merged commit 5e27370 into release/4.11.x Dec 16, 2024
16 checks passed
@ben-polinsky ben-polinsky deleted the mergify/bp/release/4.11.x/pr-7470 branch December 16, 2024 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants