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

Build tools: Bump typedoc to a version that supports typescript 5.6 #7353

Merged
merged 10 commits into from
Nov 14, 2024

Conversation

grigasp
Copy link
Member

@grigasp grigasp commented Nov 13, 2024

This should allow consumers avoid the following message when installing packages:

 WARN  Issues with peer dependencies found
apps/build-tools
└─┬ @itwin/build-tools 4.10.0-dev.33
  └─┬ typedoc 0.25.13
    └── ✕ unmet peer typescript@"4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x": found 5.6.3 in @itwin/build-tools

Will need to backport to 4.10 and 4.11.

@grigasp grigasp requested review from a team as code owners November 13, 2024 06:17
@grigasp grigasp enabled auto-merge (squash) November 13, 2024 06:17
@grigasp
Copy link
Member Author

grigasp commented Nov 13, 2024

CI is failing, because all packages' docs scripts are passing --includes=../../generated-docs/extract command line option to the betools docs script. This results in the option being passed down to typedoc and 0.26 removed it. It seems there are some replacements for the option, but I don't understand why that --includes option was used in the first place. AFAIK, all the extractions from generated-docs/extract are injected into documentation by the doc site build tool rather than typedoc.

I also dug through the history of the docs script to see if any commit messages could explain it, but the --includes option is there from the initial commit, so that was no help.

@aruniverse @ben-polinsky I'm thinking about removing the option, but not sure if we have any way to tell if the change breaks anything. Any ideas?

@ben-polinsky
Copy link
Contributor

ben-polinsky commented Nov 13, 2024

I'm thinking about removing the option, but not sure if we have any way to tell if the change breaks anything. Any ideas?

Not sure of the history here, but I can test out a local build and ensure extractions are working without the flag. Then we can test in dev.

@aruniverse
Copy link
Member

@Mergifyio backport release/4.10.x release/4.11.x

Copy link
Contributor

mergify bot commented Nov 13, 2024

backport release/4.10.x release/4.11.x

✅ Backports have been created

@ben-polinsky
Copy link
Contributor

Looks good locally!

@grigasp
Copy link
Member Author

grigasp commented Nov 13, 2024

Looks good locally!

Great. Feel free to commit your local changes to this branch. Or I can do that tomorrow morning.

@ben-polinsky
Copy link
Contributor

Tested on dev and looks good.

@grigasp grigasp merged commit 05466dd into master Nov 14, 2024
16 checks passed
@grigasp grigasp deleted the build-tools/bump-typedoc-version branch November 14, 2024 03:28
mergify bot pushed a commit that referenced this pull request Nov 14, 2024
…6` (#7353)

(cherry picked from commit 05466dd)

# Conflicts:
#	common/config/rush/pnpm-lock.yaml
mergify bot pushed a commit that referenced this pull request Nov 14, 2024
…6` (#7353)

(cherry picked from commit 05466dd)

# Conflicts:
#	common/config/rush/pnpm-lock.yaml
grigasp added a commit that referenced this pull request Nov 14, 2024
…6` (backport #7353) [release/4.11.x] (#7369)

Co-authored-by: Grigas <35135765+grigasp@users.noreply.github.com>
grigasp added a commit that referenced this pull request Nov 14, 2024
…6` (backport #7353) [release/4.10.x] (#7368)

Co-authored-by: Grigas <35135765+grigasp@users.noreply.github.com>
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.

4 participants