Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

doc: Avoid doctype reexports canonicalization issue #1354

Merged
merged 1 commit into from
Feb 10, 2024
Merged

Conversation

mjameswh
Copy link
Contributor

@mjameswh mjameswh commented Feb 7, 2024

What was changed and why?

  • Change the order in which packages are visited by the TypeDoc exporter.
    • When types are reexported, TypeDoc canonicalize references to that type to the first public export it encountered. Given the previous package ordering, that means that, for example, ApplicationFailure would appear under the activity package, rather than the common package.
  • Updated our prepublish script to also update devDependecies and peerDependencies.
    • Some users have faced issues with this using the 1.9.0 release. 1.9.1 fixed the invalid dependencies, but the change to the script had not been comited.

@mjameswh mjameswh marked this pull request as ready for review February 9, 2024 18:24
@mjameswh mjameswh requested a review from a team as a code owner February 9, 2024 18:24
@mjameswh mjameswh enabled auto-merge (squash) February 9, 2024 18:45
@mjameswh mjameswh merged commit 1394965 into main Feb 10, 2024
29 of 30 checks passed
@mjameswh mjameswh deleted the docs-priority branch February 10, 2024 04:08
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants