-
Notifications
You must be signed in to change notification settings - Fork 1.7k
[CP][beta channel] 2a8f3d5 - Update dartdoc revision to 2.0.0 #46983
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
Comments
To elaborate on the risk, the most important downstream users of dartdoc use |
Can you elaborate on the impact? We use dartdoc to publish api.dart.dev, api.flutter.dev, and the api docs on pub.dev? From my read of the issue, none of these would be affected by this (they either don't hit the issue or take from the pub published dartdoc). Is that correct? The only people that would be affected are the ones that run dartdoc manually from the sdk? |
The dartdoc in the SDK is used to generate the docs on api.dart.dev for that SDK version. Otherwise, folks manually running dartdoc from the SDK will be the only people impacted by this change. |
For those curious, this is the actual diff on the dartdoc side that would come from updating the DEPS reference: And this is the original commit that fixed the underlying issue in dartdoc: dart-lang/dartdoc@ba16d63 |
This is approved, but for the first round of cherry-picks after the stable. I'll update w/ the |
FYI, api.dart.dev docs are built with the dartdoc in the Dart SDK. Currently, they seem to work https://api.dart.dev/beta so perhaps the SDK isn't affected by this issue. |
I should have read the last comment more carefully, if we want to CP onto 2.14 in the first 2.14 hotfix rather than merge this before the release |
@athomas - yup, that was my thinking. This is essentially merge-to-stable for the stable that's not yet out :) |
Approved! @athomas - note that this is now a cp to stable, not beta. Not sure if that will be an issue for you. If so, I'm sure @jcollins-g could provide a new cp. |
Merged to stable in 3300f32 ( |
commit(s) to merge: 2a8f3d5
merge instructions: https://dart-review.googlesource.com/c/sdk/+/211085. (Patch had conflict in DEPS, CL resolves)
What is the issue: Dartdoc's revision at beta HEAD contained a crash bug in the generic typedef support introduced when the new lookup code was switched on by default.
What is the fix: The proposed fix is to update the revision of dartdoc shipped with 2.14 to the current stable release of dartdoc, 2.0.0.
Why cherrypick: Having these bugs fixed would prevent reports of crash bugs in dartdoc that can be corrected by
pub global activate dartdoc
.Risk: The cherry pick to update dartdoc can't be done to only incorporate the bugfixes as per usual cherry-pick policy. It is therefore possible that changing revisions will introduce new problems of some sort. To mitigate this I have built and tested a beta SDK with the compiled dartdoc to smoke test it by hand, testing it on dartdoc's "test package" and the SDK itself.
Link to original issue(s): dart-lang/dartdoc#2740 dart-lang/dartdoc#2755
/cc @kevmoo @mit-mit @whesse @athomas @vsmenon @franklinyow
The text was updated successfully, but these errors were encountered: