chore: bump docusaurus to canary verison #428

ruibaby · 2024-10-12T16:55:03Z

Support for building projects via rspack has been added in the latest Canary version of Docusaurus, which significantly improves compilation speed.

❯ hyperfine --prepare 'pnpm clear' --runs 5 'DOCUSAURUS_FASTER=false pnpm build' 'DOCUSAURUS_FASTER=true pnpm build'
Benchmark 1: DOCUSAURUS_FASTER=false pnpm build
  Time (mean ± σ):     70.715 s ± 17.150 s    [User: 134.096 s, System: 31.651 s]
  Range (min … max):   52.330 s … 88.497 s    5 runs

Benchmark 2: DOCUSAURUS_FASTER=true pnpm build
  Time (mean ± σ):     30.094 s ±  4.572 s    [User: 64.061 s, System: 28.384 s]
  Range (min … max):   25.832 s … 37.655 s    5 runs

Summary
  DOCUSAURUS_FASTER=true pnpm build ran
    2.35 ± 0.67 times faster than DOCUSAURUS_FASTER=false pnpm build

see: facebook/docusaurus#10556 (comment)

None

Signed-off-by: Ryan Wang <[email protected]>

vercel · 2024-10-12T16:55:07Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
halo-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 31, 2024 9:36am

ruibaby · 2024-10-14T02:14:58Z

/hold

JohnNiang

/lgtm

slorber · 2024-10-16T07:22:37Z

Thanks for trying it @ruibaby

I'm a bit disappointed by the limited gain here 😅 it should be even faster.

Can you please run a faster build with DOCUSAURUS_PERF_LOGGER=true and share the log? (see facebook/docusaurus#4765)

Also added some troubleshooting notes here:

facebook/docusaurus#10556 (comment)

ruibaby · 2024-10-16T08:50:24Z

Hi @slorber Thanks for following up.

I tested again with a cold build and logger enabled, and here are the results:

cold builds:

❯ hyperfine --prepare 'pnpm clear' --runs 5 'DOCUSAURUS_FASTER=false pnpm build' 'DOCUSAURUS_FASTER=true pnpm build'
Benchmark 1: DOCUSAURUS_FASTER=false pnpm build
  Time (mean ± σ):     70.715 s ± 17.150 s    [User: 134.096 s, System: 31.651 s]
  Range (min … max):   52.330 s … 88.497 s    5 runs

Benchmark 2: DOCUSAURUS_FASTER=true pnpm build
  Time (mean ± σ):     30.094 s ±  4.572 s    [User: 64.061 s, System: 28.384 s]
  Range (min … max):   25.832 s … 37.655 s    5 runs

Summary
  DOCUSAURUS_FASTER=true pnpm build ran
    2.35 ± 0.67 times faster than DOCUSAURUS_FASTER=false pnpm build

logger enabled:

❯ DOCUSAURUS_FASTER=true DOCUSAURUS_PERF_LOGGER=true pnpm build

> @halo-dev/[email protected] build /Users/ryanwang/Workspace/github/ruibaby/docs
> docusaurus build

[PERF] Get locales to build - 130.58 ms
[INFO] [zh-Hans] Creating an optimized production build...
[PERF] Build > zh-Hans > Load site > Load plugins > Init plugins - 149.13 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load classic@default > translatePluginContent() - 7.94 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load google-gtag@default - 8.30 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load pages@default > loadContent() - 9.15 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load classic@default - 12.37 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load pages@default - 12.65 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load docs@default > loadContent() - 4.17 seconds!
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load docs@default > contentLoaded() - 40.46 ms
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content > Load docs@default - 4.21 seconds!
[PERF] Build > zh-Hans > Load site > Load plugins > Load plugins content - 4.21 seconds!
[PERF] Build > zh-Hans > Load site > Load plugins - 4.37 seconds!
[PERF] Build > zh-Hans > Load site > Create site files - 28.67 ms
[PERF] Build > zh-Hans > Load site - 4.40 seconds!
[PERF] Build > zh-Hans > Creating rspack bundler configs - 70.99 ms
●  ━━━━━━━━━━━━━━━━━━━━━━━━━ (8%) setup compilation
● Client ━━━━━━━━━━━━━━━━━━━━━━━━━ (100%) emitting after emit                                          [PERF] Build > zh-Hans > Bundling with rspack - 6.86 seconds!
[PERF] Build > zh-Hans > SSG > Load App renderer > Server bundle size = 2.418 MB
[PERF] Build > zh-Hans > SSG > Load App renderer > Evaluate server bundle - 57.41 ms
[PERF] Build > zh-Hans > SSG > Load App renderer - 58.15 ms
[PERF] Build > zh-Hans > SSG > Generate static files - 4.98 seconds!
[PERF] Build > zh-Hans > SSG - 5.04 seconds!
[PERF] Build > zh-Hans > Deleting server bundle - 32.12 ms
[PERF] Build > zh-Hans > postBuild() - 60.33 ms
[WARNING] Docusaurus found broken anchors!

Please check the pages of your site in the list below, and make sure you don't reference any anchor that does not exist.
Note: it's possible to ignore broken anchors with the 'onBrokenAnchors' Docusaurus configuration, and let the build pass.

Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /2.16/developer-guide/plugin/publish:
   -> linking to /2.16/developer-guide/plugin/introduction#%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6
- Broken anchor on source page path = /2.17/developer-guide/plugin/publish:
   -> linking to /2.17/developer-guide/plugin/introduction#%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6
- Broken anchor on source page path = /2.18/developer-guide/plugin/publish:
   -> linking to /2.18/developer-guide/plugin/introduction#%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6
- Broken anchor on source page path = /2.19/developer-guide/plugin/publish:
   -> linking to /2.19/developer-guide/plugin/introduction#%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6
- Broken anchor on source page path = /2.20.0-SNAPSHOT/developer-guide/plugin/publish:
   -> linking to /2.20.0-SNAPSHOT/developer-guide/plugin/introduction#%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6
- Broken anchor on source page path = /developer-guide/plugin/publish:
   -> linking to /developer-guide/plugin/introduction#%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6

[PERF] Build > zh-Hans > Broken links checker - 65.01 ms
[SUCCESS] Generated static files in "build".
[PERF] Build > zh-Hans - 16.53 seconds!
[PERF] Build - 16.53 seconds!
[INFO] Use `npm run serve` command to test your build locally.

slorber · 2024-10-17T08:26:43Z

Ah 😄 didn't see the missing clear preparation command.

So, it's 2.35 faster in the end. Could be better but already a significant improvement!

Are you building multiple locales? Because the log shows it builds in 16s for zh-Hans, I assume there are 2 locales maybe.

ruibaby · 2024-10-17T08:34:58Z

@slorber Thanks to the work of docusaurus and rspack teams, the build is much faster now. Previously, we had to delete some old versions of documents due to the build speed issue.

There is also a problem with the zoom image plugin, because it limits the version number of docusaurus. We will merge this PR when docusaurus releases 3.6.

Thanks also to @hardfist for his effort at hardfist/docusaurus-rspack#1, which made it possible to integrate rspack into docusaurus.

ruibaby · 2024-10-17T08:37:16Z

Are you building multiple locales? Because the log shows it builds in 16s for zh-Hans, I assume there are 2 locales maybe.

Currently we only have zh-Hans

slorber · 2024-10-17T08:45:48Z

Thanks

I find it weird if you have 1 locale that hyperfine reports 30.094 and the log reports 16.53 seconds

I don't know what's the problem with image zoom but it's not a core Docusaurus plugin so we are not really responsible for it 😅

ruibaby · 2024-10-17T08:52:51Z

I don't know what's the problem with image zoom but it's not a core Docusaurus plugin so we are not really responsible for it 😅

Yeah, I know the reason. Because this community plugin sets peerDependencies in package.json, the current canary version does not meet its expectations and fails to compile.

https://github.com/gabrielcsapo/docusaurus-plugin-image-zoom/blob/main/package.json#L39

slorber · 2024-10-17T11:11:42Z

I see thanks. I'll look for a solution to this canary adoption problem, not the first time it came up.

slorber · 2024-10-31T09:06:35Z

FYI canaries start with 3.5.2 (latest version) now, so I guess it should work better with community plugins now.

Signed-off-by: Ryan Wang <[email protected]>

ruibaby · 2024-10-31T09:34:35Z

/unhold

guqing

/approve

ruibaby · 2024-10-31T09:39:35Z

FYI canaries start with 3.5.2 (latest version) now, so I guess it should work better with community plugins now.

All is well, this PR will be merged

JohnNiang

/lgtm

f2c-ci-robot · 2024-10-31T09:48:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: guqing, JohnNiang

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [JohnNiang,guqing]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

chore: bump docusaurus to canary verison

a094ab5

Signed-off-by: Ryan Wang <[email protected]>

f2c-ci-robot bot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Oct 12, 2024

f2c-ci-robot bot requested review from JohnNiang and lan-yonghui October 12, 2024 16:55

vercel bot deployed to Preview October 12, 2024 16:57 View deployment

Merge branch 'main' into chore/use-rspack

7a53182

vercel bot deployed to Preview October 14, 2024 02:10 View deployment

f2c-ci-robot bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 14, 2024

Merge branch 'main' into chore/use-rspack

1a50699

vercel bot deployed to Preview October 14, 2024 04:40 View deployment

JohnNiang approved these changes Oct 14, 2024

View reviewed changes

f2c-ci-robot bot assigned JohnNiang Oct 14, 2024

f2c-ci-robot bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 14, 2024

Merge branch 'main' into chore/use-rspack

0ac11a2

f2c-ci-robot bot removed the lgtm Indicates that a PR is ready to be merged. label Oct 15, 2024

vercel bot deployed to Preview October 15, 2024 04:33 View deployment

f2c-ci-robot bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 31, 2024

Merge remote-tracking branch 'upstream/main' into chore/use-rspack

09758e2

f2c-ci-robot bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 31, 2024

vercel bot had a problem deploying to Preview October 31, 2024 09:21 Failure

Bump versions

7a6ce3c

Signed-off-by: Ryan Wang <[email protected]>

vercel bot had a problem deploying to Preview October 31, 2024 09:29 Failure

f2c-ci-robot bot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Oct 31, 2024

Fix build

f8abe73

f2c-ci-robot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 31, 2024

guqing approved these changes Oct 31, 2024

View reviewed changes

vercel bot deployed to Preview October 31, 2024 09:36 View deployment

JohnNiang approved these changes Oct 31, 2024

View reviewed changes

f2c-ci-robot bot added the lgtm Indicates that a PR is ready to be merged. label Oct 31, 2024

f2c-ci-robot bot merged commit aa466d9 into halo-dev:main Oct 31, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: bump docusaurus to canary verison #428

chore: bump docusaurus to canary verison #428

ruibaby commented Oct 12, 2024 •

edited

Loading

vercel bot commented Oct 12, 2024 •

edited

Loading

ruibaby commented Oct 14, 2024

JohnNiang left a comment

slorber commented Oct 16, 2024 •

edited

Loading

ruibaby commented Oct 16, 2024

slorber commented Oct 17, 2024 •

edited

Loading

ruibaby commented Oct 17, 2024

ruibaby commented Oct 17, 2024

slorber commented Oct 17, 2024

ruibaby commented Oct 17, 2024

slorber commented Oct 17, 2024

slorber commented Oct 31, 2024

ruibaby commented Oct 31, 2024

guqing left a comment

ruibaby commented Oct 31, 2024

JohnNiang left a comment

f2c-ci-robot bot commented Oct 31, 2024

chore: bump docusaurus to canary verison #428

chore: bump docusaurus to canary verison #428

Conversation

ruibaby commented Oct 12, 2024 • edited Loading

vercel bot commented Oct 12, 2024 • edited Loading

ruibaby commented Oct 14, 2024

JohnNiang left a comment

Choose a reason for hiding this comment

slorber commented Oct 16, 2024 • edited Loading

ruibaby commented Oct 16, 2024

slorber commented Oct 17, 2024 • edited Loading

ruibaby commented Oct 17, 2024

ruibaby commented Oct 17, 2024

slorber commented Oct 17, 2024

ruibaby commented Oct 17, 2024

slorber commented Oct 17, 2024

slorber commented Oct 31, 2024

ruibaby commented Oct 31, 2024

guqing left a comment

Choose a reason for hiding this comment

ruibaby commented Oct 31, 2024

JohnNiang left a comment

Choose a reason for hiding this comment

f2c-ci-robot bot commented Oct 31, 2024

ruibaby commented Oct 12, 2024 •

edited

Loading

vercel bot commented Oct 12, 2024 •

edited

Loading

slorber commented Oct 16, 2024 •

edited

Loading

slorber commented Oct 17, 2024 •

edited

Loading