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.

Sign up for GitHub

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

Jump to bottom

Reenable typedoc with workarounds to avoid out-of-memory crash. #399

Merged
merged 1 commit into from
Nov 15, 2022
Merged

Reenable typedoc with workarounds to avoid out-of-memory crash. #399

merged 1 commit into from
Nov 15, 2022

Conversation

mikelehen
Copy link
Contributor

@mikelehen mikelehen commented Nov 15, 2022 •
edited
Loading

Typedoc has issues with monorepo support using lots of memory. See #356 and TypeStrong/typedoc#1606.

This avoids the crash in two different ways:

  1. I increased the node heap size to 8192 which seems to be sufficient to make the build succeed for now.
  2. For now I am pointing typedoc at the packages' source code directly rather than using the monorepo support. This uses a lot less memory and is a lot faster, though the resulting docs are not formatted as nicely (it looks like all the code lives in one big package). We can revisit this when Cross-package references in monorepository not working TypeStrong/typedoc#1835 is fixed.

I'm also upgrading typedoc just for good measure, though I don't think it fixes anything.

Not including a changeset, since this has no effect on our packages.

Fixes #356 for now.

@changeset-bot
Copy link

changeset-bot bot commented Nov 15, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: 21e3aae

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Nov 15, 2022 •
edited
Loading

Visit the preview URL for this PR (updated for commit 21e3aae):

https://act-now-packages--pr399-mikelehen-more-space-c9dvt44x.web.app

(expires Tue, 22 Nov 2022 19:02:49 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: ad39b6c29b2ae4e8fa7983fbf3316d2e514cb069

@mikelehen mikelehen changed the title Test building docs with more heap space. Increase node memory for running typedoc and reenable typedoc. Nov 15, 2022
@mikelehen mikelehen marked this pull request as ready for review November 15, 2022 15:39
mikelehen
mikelehen commented Nov 15, 2022
View reviewed changes
package.json
@@ -54,7 +54,7 @@
"ts-jest": "^28.0.2",
"ts-node": "^10.7.0",
"tsconfig-paths": "^4.0.0",
"typedoc": "^0.23.10",
"typedoc": "^0.23.21",
Copy link
Contributor Author

@mikelehen mikelehen Nov 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upgrading for good measure, though it wasn't actually necessary.

@mikelehen
Fix typedoc out-of-memory crashes.
21e3aae 
Typedoc has issues with monorepo support using lots of memory.  See #356 and TypeStrong/typedoc#1835.

This avoids the crash in two different ways:
1. I increased the node heap size to 8192 which seems to be sufficient to make the build succeed for now.
2. For now I am pointing typedoc at the source code directly rather than using the monorepo support. This uses a lot less memory and is a lot faster.
@mikelehen mikelehen force-pushed the mikelehen/more-space branch from a642bbc to 21e3aae Compare November 15, 2022 18:56
@mikelehen mikelehen changed the title Increase node memory for running typedoc and reenable typedoc. Reenable typedoc with workarounds to avoid out-of-memory crash. Nov 15, 2022
chasulin
chasulin approved these changes Nov 15, 2022
View reviewed changes
Copy link
Contributor

@chasulin chasulin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌🏼🙌🏼

@mikelehen mikelehen merged commit 209259b into develop Nov 15, 2022
@mikelehen mikelehen deleted the mikelehen/more-space branch November 15, 2022 19:58
@mikelehen mikelehen mentioned this pull request Jan 2, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chasulin chasulin chasulin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Investigate 'Javascript heap out of memory' error
2 participants
@mikelehen @chasulin