build_runner

• Remove usage of set literals to fix errors on older sdks that don't support them.

• Fix an issue where we might re-use stale build snapshots, which could only be resolved by deleting the .dart_tool dir (or doing a clean).
• Depend on the latest build_runner_core and build_daemon releases.

• Fix issue where daemon command wouldn't properly shutdown.
• Allow running when the root package, or a path dependency, is named test.

• Fix issue where daemon command would occasionally color a log.

• Prevent terminals being launched when running the daemon command on Windows.
• No longer assumeTty when logging through the daemon command.
• Update build_daemon to version 0.4.0.
• Update build_runner_core to version 2.0.3.
• Ensure the daemon command always exits.

• Fix a bug with the build daemon where the output options were ignored.

• Update build_resolvers to version 1.0.0.

• Fix a bug where changing between --live-reload and --hot-reload might not work due to the etags for the injected JS not changing when they should.

• Change the format of Build Daemon messages.
• Build Daemon asset server now properly waits for build results.
• Build Daemon now properly signals the start of a build.
• Fix path issues with Daemon command under Windows.

• Update package:build_runner_core to version 2.0.1.

• Support building through package:build_daemon.
• Update package:build_runner_core to version 2.0.0.

• Update to package:graphs version 0.2.0.
• Fix an issue where when running from source in watch mode the script would delete itself when it shouldn't.
• Add digest string to the asset graph visualization.
• Added a filter box to the asset graph visualization.
• Allow build version 1.1.x.

• Improve error message when the generated build script cannot be parsed or compiled and exit with code 78 to indicate that there is a problem with configuration in the project or a dependency's build.yaml.

Bug Fixes

• Handle re-snapshotting the build script on SDK updates.
• Suppress header for the Bootstrap logger.

New Features

• The build script will now be ran from snapshot, which improves startup times.
• The build script will automatically re-run itself when the build script is changed, instead of requiring the user to re-run it manually.

Breaking Changes

• Massive cleanup of the public api. The only thing exported from this package is now the run method. The goal is to reduce the surface area in order to stabilize this package, since it is directly depended on by all users.
  • Removed all exports from build_runner_core, if you are creating a custom build script you will need to import build_runner_core directly and add a dependency on it.
  • Stopped exporting the build and watch functions directly, as well as the ServeHandler.
  • If this has broken your use case please file an issue on the package and request that we export the api you were using previously. These will be considered on an individual basis but the bar for additional exports will be high.
• Removed support for the --[no-]assume-tty command line argument as it is no longer needed.

• Improve performance tracking and visualization using the timing package.
• Handle bad asset graph in the clean command.

• Added --hot-reload cli option and appropriate functionality.
• Removed dependency on cli_util.

• Added --live-reload cli option and appropriate functionality
• Migrated glob tracking to a specialized node type to fix dart-lang/build#1702.

• Added better error handling when a socket is already in use in serve mode.

Breaking Changes

• Implementations of BuildEnvironment must now implement the finalizeBuild method. There is a default implementation if you extend BuildEnvironment that is a no-op.
  • This method is invoked at the end of the build that allows you to do arbitrary additional work, such as creating merged output directories.
• The assumeTty argument on IOEnvironment has moved to a named argument since null is an accepted value.
• The outputMap field on BuildOptions has moved to the IOEnvironment class.

New Features/Updates

• Added a outputSymlinksOnly option to IOEnvironment constructor, that causes the merged output directories to contain only symlinks, which is much faster than copying files.
• Added the FinalizedAssetView class which provides a list of all available assets to the BuildEnvironment during the build finalization phase.
  • outputMap has moved from BuildOptions to this constructor, as a named argument.
• The OverridableEnvironment now supports overriding the new finalizeBuild api.
• The number of concurrent actions per phase is now limited (currently to 16), which should help with memory and cpu usage for large builds.

• Changed the default file caching logic to use an LRU cache.

• The hash dir for the asset graph under .dart_tool/build is now based on a relative path to the build script instead of the absolute path.
  • This enables .dart_tool/build directories to be reused across different computers and directories for the same project.

• Increased the upper bound for the sdk to <3.0.0.

New Features

• Added the --log-performance <dir> option which will dump performance information to <dir> after each build.
• The BuildPerformance class is now serializable, it has a fromJson constructor and a toJson instance method.
• Added support for global_options in build.yaml of the root package.
• Allow overriding the default Resolvers implementation.
• Allows building with symlinked files. Note that changes to the linked files will not trigger rebuilds in watch or serve mode.

Breaking changes

• BuildPhasePerformance.action has been replaced with BuildPhasePerformance.builderKeys.
• BuilderActionPerformance.builder has been replaced with BuilderActionPerformance.builderKey.
• BuildResult no longer has an exception or stackTrace field.
• The 'test' command through run will no longer set an exit code. All manual build scripts which call run should use the Future<int> return to set the exit code for the process.
• Dropped failOnSevere arguments and --fail-on-severe flag. Severe logs are always considered failing.
• Severe level logs now go to stdout along with other logs rather than stderr. Uncaught exceptions from the build_runner system itself still go to stderr.

• All builders with build_to: source will now be ran regardless of which directory is currently being built, see https://github.com/dart-lang/build/issues/1454 for context.
• build will now throw instead of returning a failed build result if nothing was built.
• Improve error message when a dependency has a bad build.yaml with a missing dependency.
• Sources that are not a part of a target will no longer appear in the asset graph, so they will not be readable or globbable.
• Updated the generated build script to not rely on json encode/decode for the builder options object. Instead it now directly inlines a map literal.

• Added support for building only specified top level directories.
  • The build, watch commands support positional arguments which are the directories to build. For example, pub run build_runner build web will only build the web directory.
  • The serve command treats positional args as it did before, except it will only build the directories you ask it to serve.
  • The test command will automatically only build the test directory.
  • If using the -o option, with the <dir-to-build>:<output-dir> syntax, then the <dir-to-build> will be added to the list of directories to build.
    • If additional directories are supplied with positional arguments, then those will also be built.
• Update to latest analyzer and build packages.
• Updated the serve logic to only serve files which were part of the actual build, and not stale assets. This brings the semantics exactly in line with what would be copied to the -o output directory.

• Improve search behavior on the /$graph page. Users can now query for paths and AssetID values – pkg_name|lib/pkg_name.dart.
• Commands that don't support trailing args will now appropriately fail with a usage exception.
• Fix a bug where some rebuilds would not happen after adding a new file that has outputs which were missing during the previous build.
• Fix a bug where failing actions which are no longer required can still cause the overall build to fail.

• Improve error handling on the /$graph page.
• Support the latest package:build

• Forward default options for PostProcessBuilders in the generated build script.
• If a build appears to be not making progress (no actions completed for 15 seconds), then a warning will now be logged with the pending actions.
• Now fail when a build is requested which does not build anything.
• Clean up some error messages.

• Add log message for merged output errors.

• Log the number of completed actions on successful builds.
• Support the new isRoot field for BuilderOptions so that builders can do different things for the root package.
• Deprecated PostProcessBuilder and PostProcessBuildStep. These should be imported from package:build instead.

• Clean and summarize stack traces printed with --verbose.
• Added a clean command which deletes generated to source files and the entire build cache directory.
• Bug Fix: Use the same order to compute the digest of input files to a build step when writing it as when comparing it. Previously builds would not be pruned as efficiently as they can be because the inputs erroneously looked different.

• Bug Fix: Correctly parse Window's paths with new --output semantics.

• The .packages file is now always created in the root of the output directory instead of under each top level directory.

• Allow passing multiple --output options. Each option will be split on :. The first value will be the root input directory, the second value will be the output directory. If no delimiter is provided, all resources will be copied to the output directory.
• Allow deleting files in the post process build step.
• Bug Fix: Correctly include the default allow list when multiple targets without include are provided.
• Allow logging from within a build factory.
• Allow serving assets from successful build steps if the overall build fails.
• Add a --release flag to choose the options from release_options in build.yaml. This should replace the need to use --config pointing to a release version of build.yaml.

• Improved the layout of /$perf, especially after browser window resize.
• pub run build_runner exits with a error when invoked with an unsupported command.
• Bug Fix: Update outputs in merged directory for sources which are not used during the build. For example if web/index.html is not read to produce any generated outputs changes to this file will now get picked up during pub run build_runner watch --output build.
• Don't allow a thrown exception from a Builder to take down the entire build process - instead record it as a failed action. The overall build will still be marked as a failure, but it won't crash the process.

New Features

• Added the new PostProcessBuilder class. These are not supported in bazel, and are different than a normal Builder in some fundamental ways:
  • They don't have to declare output extensions, and can output any file as long as it doesn't conflict with an existing one. This is only checked at build time.
  • They can only read their primary input.
  • They will not cause optional actions to run - they will only run on assets that were built as a part of the normal build.
  • They can not be optional themselves, and can only output to cache.
  • Because they all run in a single phase, after other builders, none of their outputs can be used as inputs to any actions.
• Added applyPostProcess method which takes PostProcessBuilderFactorys instead of BuilderFactorys.

Breaking Changes

• BuilderApplication now has a builderActionFactories getter instead of a builderFactories getter.
• The default constructor for BuilderApplication has been replaced with BuilderApplication.forBuilder and BuilderApplication.forPostProcessBuilder.

• Fix a bug where a chain of Builders would fail to run on some outputs from previous steps when the generated asset did not match the target's sources.
• Added support for serving on IPv4 loopback when the server hostname is 'localhost' (the default).
• Added support for serving on any connection (both IPv4 and IPv6) when the hostname is 'any'.
• Improved stdout output.

• Fix a concurrent modification error when using listAssets when an asset could be written.

• Added the --log-requests flag to the serve command, which will log all requests to the server.
• Build actions using findAssets will be more smartly invalidated.
• Added a warning if using serve mode but no directories were found to serve.
• The --output option now only outputs files that were required for the latest build. Previously when switching js compilers you could end up with ddc modules in your dart2js output, even though they weren't required. See https://github.com/dart-lang/build/issues/1033.
• The experimental create_merged_dir binary is now removed, it can't be easily supported any more and has been replaced by the --output option.
• Builders which write to source are no longer guaranteed to run before builders which write to cache.
• Honors runs_before configuration from Builder definitions.
• Honors applies_builders configuration from Builder definitions.

• Performance tracking is now disabled by default, and you must pass the --track-performance flag to enable it.
• The heartbeat logger will now log the current number of completed versus scheduled actions, and it will log once a second instead of every 5 seconds.
• Builds will now be invalidated when the dart SDK is updated.
• Fixed the error message when missing a build_test dependency but trying to run the test command.
• The build script will now exit on changes to build.yaml files.

• Switch to use a PollingDirectoryWatcher on windows, which should fix file watching with the --output option. Follow along at https://github.com/dart-lang/tools/issues/1713 for more details.

New Features

• Added a basic performance visualization. When running with serve you can now navigate to /$perf and get a timeline of all actions. If you are experiencing slow builds (especially incremental ones), you can save the html of that page and attach it to bug reports!

Bug Fixes

• When using --output we will only clean up files we know we previously output to the specified directory. This should allow running long lived processes such as servers in that directory (as long as they don't hold open file handles).

• Fix bug where relative imports in a dependencies build.yaml would break all downstream users, https://github.com/dart-lang/build/issues/995.

New Features

• Added command line args to override config for builders globally. The format is --define "<builder_key>=<option>=<value>". As an example, enabling the dart2js compiler for the build_web_compilers|entrypoint builder would look like this: --define "build_web_compilers|entrypoint=compiler=dart2js".

Bug Fixes

• Fixed an issue with mixed mode builds, see https://github.com/dart-lang/build/issues/924.
• Fixed some issues with exit codes and --fail-on-severe, although there are still some outstanding problems. See https://github.com/dart-lang/build/issues/910 for status updates.
• Fixed an issue where the process would hang on exceptions, see https://github.com/dart-lang/build/issues/883.
• Fixed an issue with etags not getting updated for source files that weren't inputs to any build actions, https://github.com/dart-lang/build/issues/894.
• Fixed an issue with hidden .DS_Store files on mac in the generated directory, https://github.com/dart-lang/build/issues/902.
• Fixed test output so it will use the compact reporter, https://github.com/dart-lang/build/issues/821.

• Support the latest analyzer package.

• Fixed a bug with build to source and watch mode that would result in an infinite build loop, #962.

• Add --config option to use a different build.yaml at build time.

• The top level run method now returns an int which represents an exitCode for the command that was executed.
  • For now we still set the exitCode manually as well but this will likely change in the next breaking release. In manual scripts you should await the call to run and assign that to exitCode to be future-proofed.

• Avoid watching hosted dependencies for file changes.

• Update to package:build version 0.12.0.
• Removed the DigestAssetReader interface, the digest method has now moved to the core AssetReader interface. We are treating this as a non-breaking change because there are no known users of this interface.

• Add more human friendly duration printing.
• Added the --output <dir> (or -o) argument which will create a merged output directory after each build.
• Added the --verbose (or -v) flag which enables verbose logging.
  • Disables stack trace folding and terse stack traces.
  • Disables the overwriting of previous info logs.
  • Sets the default log level to Level.ALL.
• Added pubspec.yaml and pubspec.lock to the allow list for the root package sources.

• Bug fix for using the --output flag when you have no test directory.

• Allows using files in any build targets in the root package as sources if they fall outside the hardcoded allow list.
• Changes to the root .packages file during watch mode will now cause the build script to exit and prompt the user to restart the build.

• Added the flag --low-resources-mode, which defaults to false.

• Added the flag --fail-on-severe, which defaults to false. In a future version this will default to true, which means that logging a message via log.severe will fail the build instead of just printing to the terminal. This would match the current behavior in bazel_codegen.
• Added the test command to the build_runner binary.