-
Notifications
You must be signed in to change notification settings - Fork 29.7k
[CP-stable]Roll dartdoc to 9.0.0 #178638
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
[CP-stable]Roll dartdoc to 9.0.0 #178638
Conversation
Required for compatibility with the latest Dart SDK and analyzer package
|
@szakarias please fill out the PR description above, afterwards the release team will review this request. |
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request is a cherry-pick to a stable branch. While the repository's style guide suggests that such changes are not typically reviewed (lines 25-26), I've noticed a potential omission. The script being modified contains a comment that requires updating dartdoc_options.yaml when the dartdoc version is changed. This step appears to be missing. I've added a comment to highlight this, as it could impact the quality of the generated documentation.
| # When updating to a new dartdoc version, please also update | ||
| # `dartdoc_options.yaml` to include newly introduced error and warning types. | ||
| "$DART" pub global activate dartdoc 8.3.3 | ||
| "$DART" pub global activate dartdoc 9.0.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment on lines 122-123 states that dartdoc_options.yaml should be updated when the dartdoc version is changed. This PR updates dartdoc to version 9.0.0, which introduces several new warnings (e.g., not-implemented, package-not-found). However, the corresponding dartdoc_options.yaml file doesn't appear to have been updated in this PR to include these new warnings. Please ensure the relevant configuration file is updated as per the instructions in the comment.
|
I am going to go ahead and land this assuming it is correct to get a build created. I am also not going to add a changelog since I think this impact doc creation. |
2ca3bb8
into
flutter:flutter-3.38-candidate.0
This pull request is created by automatic cherry pick workflow
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
Issue Link:
What is the link to the issue this cherry-pick is addressing?
< Replace with issue link here >
#178639
Changelog Description:
Explain this cherry pick in one line that is accessible to most Flutter developers. See best practices for examples
Classes marked with
@Deprecated.implementshould not be crossed out.Impact Description:
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)? Does it impact development (ex. flutter doctor crashes when Android Studio is installed), or the shipping production app (the app crashes on launch)
Confusing dartdoc rendering on https://api.flutter.dev
Workaround:
Is there a workaround for this issue?
N/A
Risk:
What is the risk level of this cherry-pick?
Test Coverage:
Are you confident that your fix is well-tested by automated tests?
Validation Steps:
What are the steps to validate that this fix works?
N/A