diff --git a/packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md b/packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md index 79ee08d2df1..e9bb5869a93 100644 --- a/packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md +++ b/packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md @@ -1,14 +1,38 @@ This is draft for future release notes, that are going to land on [the Flutter website](https://docs.flutter.dev/development/tools/devtools/release-notes). -# DevTools 2.19.0 release notes +# DevTools 2.21.0 release notes Dart & Flutter DevTools - A Suite of Performance Tools for Dart and Flutter -# Memory updates +## General updates +TODO: Remove this section if there are not any general updates. + +## Inspector updates +TODO: Remove this section if there are not any general updates. + +## Performance updates +TODO: Remove this section if there are not any general updates. + +## CPU profiler updates +TODO: Remove this section if there are not any general updates. + +## Memory updates +TODO: Remove this section if there are not any general updates. + +## Debugger updates +TODO: Remove this section if there are not any general updates. + +## Network profiler updates +TODO: Remove this section if there are not any general updates. + +## Logging updates +TODO: Remove this section if there are not any general updates. + +## App size tool updates +TODO: Remove this section if there are not any general updates. + +## Changelog +More details about changes and fixes are available in the DevTools +[changelog](https://github.com/flutter/devtools/blob/master/CHANGELOG.md). -- Retired the Analysis tab - (#4714)[https://github.com/flutter/devtools/pull/4714] -- Added a new tab, Diff, to enable memory leak detection and troubleshooting -by comparing heap snapshots, and providing insights about the number of -instances, shallow size, retained size, and retaining -paths - (#4714)[https://github.com/flutter/devtools/pull/4714] diff --git a/packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md b/packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md index 262e84c5c78..a3a4ef40939 100644 --- a/packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md +++ b/packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md @@ -5,31 +5,31 @@ This is draft for future release notes, that are going to land on Dart & Flutter DevTools - A Suite of Performance Tools for Dart and Flutter -# General updates +## General updates TODO: Remove this section if there are not any general updates. -# Inspector updates +## Inspector updates TODO: Remove this section if there are not any general updates. -# Performance updates +## Performance updates TODO: Remove this section if there are not any general updates. -# CPU profiler updates +## CPU profiler updates TODO: Remove this section if there are not any general updates. -# Memory updates +## Memory updates TODO: Remove this section if there are not any general updates. -# Debugger updates +## Debugger updates TODO: Remove this section if there are not any general updates. -# Network profiler updates +## Network profiler updates TODO: Remove this section if there are not any general updates. -# Logging updates +## Logging updates TODO: Remove this section if there are not any general updates. -# App size tool updates +## App size tool updates TODO: Remove this section if there are not any general updates. ## Changelog diff --git a/tool/README.md b/tool/README.md index 82ce414a521..f2d7490058b 100644 --- a/tool/README.md +++ b/tool/README.md @@ -6,8 +6,8 @@ Make sure: 1. You have a local checkout of the Dart SDK - (for getting started instructions, see [sdk/CONTRIBUTING.md](https://github.com/dart-lang/sdk/blob/main/CONTRIBUTING.md)). 2. Ensure your `.bashrc` sets `$LOCAL_DART_SDK` - - ```shell + + ```shell DART_SDK_REPO_DIR= export LOCAL_DART_SDK=$DART_SDK_REPO_DIR/sdk ``` @@ -15,7 +15,7 @@ Make sure: - `git rebase-update`. 4. Your Flutter version is equal to latest candidate release branch: - Run `./tool/update_flutter_sdk.sh --local` from the main devtools directory. -5. You have goma [configured](http://go/ma-mac-setup). +5. You have goma [configured](http://go/ma-mac-setup). ### Prepare the release @@ -69,7 +69,7 @@ These packages always have their version numbers updated in lock, so we don't ha intended to do the bulk of the work, but still needs manual review. * Verify * that the version for the CHANGELOG entry was correctly generated - * that the entries don't have any syntax errors. + * that the entries don't have any syntax errors. #### Push the local branch @@ -79,7 +79,7 @@ NEW_DEVTOOLS_VERSION=2.7.0 # Change this to the new version ```shell git add . && \ -git commit -m “Prepare for $NEW_DEVTOOLS_VERSION release.” && \ +git commit -m "Prepare for $NEW_DEVTOOLS_VERSION release." && \ git push origin release_$NEW_DEVTOOLS_VERSION; ``` @@ -168,7 +168,7 @@ From the git GUI tool or from github.com directly: ./tools/build.py -mrelease -ax64 create_sdk; ``` -- Verify that running `dart devtools` launches the version of DevTools you just released. +- Verify that running `dart devtools` launches the version of DevTools you just released. - for OSX ```shell xcodebuild/ReleaseX64/dart-sdk/bin/dart devtools @@ -179,7 +179,7 @@ From the git GUI tool or from github.com directly: ``` - If the version of DevTools you just published to CIPD loads properly - + > You may need to hard reload and clear your browser cache in order to see the changes. - push up the SDK CL for review. @@ -203,13 +203,13 @@ Release notes should contain details about the user-facing changes included in t These notes are shown directly in DevTools when a user opens a new version of DevTools. -1. Request the team to verify their important user facing changes are documented in +1. Request the team to verify their important user facing changes are documented in [release-notes-next.md][1]. 2. See the release notes [README.md](https://github.com/flutter/devtools/blob/master/packages/devtools_app/lib/src/framework/release_notes/README.md) for details on where to add DevTools release notes to Flutter website and how to test them. - + 3. Copy the content of [release-notes-template.md](../packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md) to [release-notes-next.md][1], to contain draft for the next release.