Dartdoc release engineering

Dartdoc Release Engineering

Overview

The basic steps for releasing a new Dartdoc package are:

1. Run pub run grinder publish at the desired commit to validate that the package has no warnings or errors and that basic sanity checks pass.
2. Create a release at this version: https://github.com/dart-lang/dartdoc/releases, select "Draft a new release". Create a new tag and pick the commit you tried at step 1.
3. Run pub publish and confirm that you want to upload the package.

However, that does not cover updating the versions in important downstream packages like the Dart SDK and Flutter.

SDK

4. Modify the DEPS file at the root of the SDK package to increment the dartdoc version.
5. Also upgrade any versions of dependent packages. Check for this with:

  git diff [previous version tag] pubspec.yaml
  git diff [previous version tag] pubspec.lock

6. As a sanity check, build and install the resulting Dart SDK.
7. Verify that dartdoc can generate documentation for itself, and the SDK, and

Submit that change via the submit queue.

Flutter

DARTDOC_ORIGINAL=[previous version tag] pub run grinder compare-flutter-warnings