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.

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

Update dartdoc to 0.35.0 #67432

Merged
merged 3 commits into from Oct 7, 2020
Merged

Conversation

@jcollins-g
Copy link
Contributor

@jcollins-g jcollins-g commented Oct 6, 2020

Description

This PR updates the version of dartdoc used by Flutter to 0.35.0. See the release notes, below, for the complete list of changes implied by this PR. Due to dart-lang/dartdoc#2360, the stub Flutter package emits a warning by default because it has no libraries. A dartdoc_options.yaml file has been added to ignore that warning.

Related Issues

Dartdoc Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v0.35.0

Tests

Tested by running dev/bots/docs.sh and spot checking the output for any additional warnings (none), and browsing the resulting documentation. Dartdoc is slightly faster with this release than the prior version (30% faster on initialization, roughly equivalent on documentation generation speed).

@flutter-dashboard flutter-dashboard bot added the team label Oct 6, 2020
@googlebot googlebot added the cla: yes label Oct 6, 2020
@jcollins-g jcollins-g requested a review from goderbauer Oct 6, 2020
@@ -0,0 +1,3 @@
dartdoc:
ignore:
- no-documentable-libraries

This comment has been minimized.

@goderbauer

goderbauer Oct 6, 2020
Member

Can you leave a comment here explaining why we turned this off?

This comment has been minimized.

@jcollins-g

jcollins-g Oct 6, 2020
Author Contributor

Done.

@@ -0,0 +1,3 @@
dartdoc:
ignore:
- no-documentable-libraries

This comment has been minimized.

@goderbauer

goderbauer Oct 6, 2020
Member

Are we adding this ignore here instead of in https://github.com/flutter/flutter/blob/master/dartdoc_options.yaml so it only applies to that empty Flutter package and nothing else?

Should https://github.com/flutter/flutter/blob/master/dartdoc_options.yaml make this warning fetal (by listing it in the error section) for all other packages?

This comment has been minimized.

@jcollins-g

jcollins-g Oct 6, 2020
Author Contributor

I don't know -- obviously something is very catastrophically wrong in Flutter, or more likely, dartdoc internals, if that happens so it seems fair to add it. I'll try it and make sure it doesn't have any adverse consequences, then follow up here.

This comment has been minimized.

@jcollins-g

jcollins-g Oct 6, 2020
Author Contributor

Oh, and yes, it is in dartdoc_options.yaml in dev/docs to limit the scope of the setting.

This comment has been minimized.

@jcollins-g

jcollins-g Oct 6, 2020
Author Contributor

@goderbauer Added as an error in the top level dartdoc_options.yaml; seems to work fine and there aren't any more stub packages hiding out that are impacted. PTAL.

Copy link
Member

@goderbauer goderbauer left a comment

LGTM

Thank you!

@fluttergithubbot fluttergithubbot merged commit e9a9a61 into flutter:master Oct 7, 2020
80 checks passed
80 checks passed
Google testing Google testing passed!
Details
Linux analyze
Details
Linux build_aar_module_test
Details
Linux build_tests
Details
Linux customer_testing
Details
Linux docs
Details
Linux firebase_abstract_method_smoke_test
Details
Linux firebase_android_embedding_v2_smoke_test
Details
Linux firebase_release_smoke_test
Details
Linux framework_tests
Details
Linux fuchsia_precache
Details
Linux gradle_fast_start_test
Details
Linux gradle_jetifier_test
Details
Linux gradle_non_android_plugin_test
Details
Linux gradle_plugin_bundle_test
Details
Linux gradle_plugin_fat_apk_test
Details
Linux gradle_plugin_light_apk_test
Details
Linux gradle_r8_test
Details
Linux module_custom_host_app_name_test
Details
Linux module_host_with_custom_build_test
Details
Linux module_test
Details
Linux plugin_dependencies_test
Details
Linux plugin_test
Details
Linux tool_tests
Details
Linux web_benchmarks_html
Details
Linux web_integration_tests
Details
Linux web_smoke_test
Details
Linux web_tests
Details
Mac build_aar_module_test
Details
Mac build_ios_framework_module_test
Details
Mac build_tests
Details
Mac customer_testing
Details
Mac framework_tests
Details
Mac gradle_fast_start_test
Details
Mac gradle_jetifier_test
Details
Mac gradle_non_android_plugin_test
Details
Mac gradle_plugin_bundle_test
Details
Mac gradle_plugin_fat_apk_test
Details
Mac gradle_plugin_light_apk_test
Details
Mac gradle_r8_test
Details
Mac module_custom_host_app_name_test
Details
Mac module_host_with_custom_build_test
Details
Mac module_test
Details
Mac module_test_ios
Details
Mac plugin_dependencies_test
Details
Mac plugin_lint_mac
Details
Mac plugin_test
Details
Mac tool_tests
Details
WIP Ready for review
Details
Windows build_aar_module_test
Details
Windows build_tests
Details
Windows customer_testing
Details
Windows framework_tests
Details
Windows gradle_fast_start_test
Details
Windows gradle_jetifier_test
Details
Windows gradle_non_android_plugin_test
Details
Windows gradle_plugin_bundle_test
Details
Windows gradle_plugin_light_apk_test
Details
Windows gradle_r8_test
Details
Windows module_custom_host_app_name_test
Details
Windows module_host_with_custom_build_test
Details
Windows module_test
Details
Windows plugin_dependencies_test
Details
Windows plugin_test
Details
Windows tool_tests
Details
analyze-linux Task Summary
Details
cla/google All necessary CLAs are signed
customer_testing-linux Task Summary
Details
deploy_gallery-linux Task Summary
Details
deploy_gallery-macos Task Summary
Details
docs-linux Task Summary
Details
flutter-build
Details
flutter-gold All golden file tests have passed.
Details
framework_tests-libraries-linux Task Summary
Details
framework_tests-misc-linux Task Summary
Details
framework_tests-widgets-linux Task Summary
Details
tool_tests-commands-linux Task Summary
Details
tool_tests-general-linux Task Summary
Details
web_integration_tests Task Summary
Details
web_smoke_test Task Summary
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.