Cleanup grind and add serving capability via dhttpd #1570
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcollins-g
changed the title
devoncarew
approved these changes
Dec 12, 2017
tool/grind.dart
Outdated
| import 'package:path/path.dart' as path; | ||
| import 'package:yaml/yaml.dart' as yaml; | ||
|
|
||
| main([List<String> args]) => grind(args); | ||
|
|
||
| final Directory docsDir = | ||
| new Directory(path.join('${Directory.systemTemp.path}', defaultOutDir)); | ||
| final Directory dartdocDocsDir = Directory.systemTemp.createTempSync('dartdoc'); |
There was a problem hiding this comment.
This script creates these temp dirs on every run, whether they're used or not. They're in temp, so it may not actually matter, but consider not creating them until the variables are first referenced?
| /// TODO(jcollins-g): move this to grinder? | ||
| Future runStreamed(String executable, List<String> arguments, | ||
| {String workingDirectory}) async { | ||
| stderr.write('$prefix+ '); |
There was a problem hiding this comment.
Yes. Modeled after set -x in bash, which echos the commands used to stderr.
|
|
||
| # The above script validates the generation; we echo the main file here. | ||
| cat dev/docs/doc/index.html | ||
| pub run grinder build-flutter-docs |
There was a problem hiding this comment.
👍 awesome - nice to make it easy for other people to run this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the beginning of a short series of dartdoc infrastructure PRs to increase release reliability and velocity.
TL;DR:
serve-sdk-docsandserve-flutter-docs.Many times I find it useful to have local serving versions of docs for browsing. To make this easier for other developers I've written some parts of what I do into the grind script. Two new targets,
serve-sdk-docsandserve-flutter-docsbuild and launch a Dart web server for browsing documentation for the SDK and flutter.This also cleans up the grind script so that we launch processes via a single entry point (
_SubprocessLauncher), which logs the command being executed as well as any pertinent environment variables, the working directory, etc in a manner familiar to shell script authors but hopefully readable to others as well. This used to be done inconsistently making for challenging debugging.The refactor also makes it a little safer to do these tasks in parallel -- this is why there is the creation of throwaway pub caches and safer temporary directory creation. A followup will have a "serve-everything" grind target that will parallelize dartdoc to save time and serve the SDK, the test package, and the flutter docs on three different ports from a single command.
Other followups will include patching new versions of dartdoc into the SDK (temporarily for a test, and for release) and Flutter automatically, with generation of review docs.