Switch document generation to use the snippets package #87231
Conversation
a8e0bb7
to
51ea616
Compare
|
Looks like luci is unhappy, though. |
|
Yeah, LUCI, what the heck? :-) Why are you killing my process? It's possible that it spawned too many processes too fast: I've seen that when the snippets tool takes too long, since dartdoc doesn't seem to throttle the invocation of the tools. |
a86c5b9
to
01a24ee
Compare
I was summoned because I thought I broke something :-) Is the expectation that we will need to increase the memory on the LUCI bots as well? IIRC we're running 8 GB for the framework VMs |
01a24ee
to
4c87d50
Compare
Yeah, we might have to. I have no idea how to change that, however. |
|
Actually, I'm wondering if dartdoc has a bug in its tool invocation throttling. I know that if I make a snippets tool that takes a while to run, I can get my machine up to a load average of 1000 or so. This current setup doesn't do that, but maybe on a slower server it does. I'll investigate that today. |
4c87d50
to
e708ba9
Compare
If we can't get it down, sign up for go/flutter-infra-office-hours and we can discuss it more (it's more of a logistics issue) |
|
Indeed, Dartdoc seems to not throttle non-Dart tool invocations. Filed dart-lang/dartdoc#2728 |
e708ba9
to
f0369a0
Compare
|
This PR is just waiting for the next Dartdoc release (and bump in the Flutter repo) to pick up the concurrency fix that is causing the OOM failure in the tests here. |
… snippets code in the Flutter repo.
f0369a0
to
fec4641
Compare
Switch document generation to use the snippets package instead of the snippets code in the Flutter repo. In the process, some bugs in sample code analysis have been fixed, and I've fixed some more errors in the samples.
This will allow the snippets package to be developed separately from the Flutter repo, and reduce the code in the Flutter repo.
The snippets code is deleted in this PR.
I also converted some comments in the snippet templates to be regular comments instead of doc comments, because having a doc comment block before the imports causes the Dart import sorter to lose the comment. They should have been regular comments in the first place.
The snippets package resides in the
assets-for-api-docsrepo.The sample analysis has also been converted to be run in parallel, and I've bumped the Dartdoc version to 1.0.2.