Skip to content

Commit 2413208

Browse files
authored
Update release instructions. (#4844)
1 parent 019614f commit 2413208

File tree

3 files changed

+49
-25
lines changed

3 files changed

+49
-25
lines changed

packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,38 @@
11
This is draft for future release notes, that are going to land on
22
[the Flutter website](https://docs.flutter.dev/development/tools/devtools/release-notes).
33

4-
# DevTools 2.19.0 release notes
4+
# DevTools 2.21.0 release notes
55

66
Dart & Flutter DevTools - A Suite of Performance Tools for Dart and Flutter
77

8-
# Memory updates
8+
## General updates
9+
TODO: Remove this section if there are not any general updates.
10+
11+
## Inspector updates
12+
TODO: Remove this section if there are not any general updates.
13+
14+
## Performance updates
15+
TODO: Remove this section if there are not any general updates.
16+
17+
## CPU profiler updates
18+
TODO: Remove this section if there are not any general updates.
19+
20+
## Memory updates
21+
TODO: Remove this section if there are not any general updates.
22+
23+
## Debugger updates
24+
TODO: Remove this section if there are not any general updates.
25+
26+
## Network profiler updates
27+
TODO: Remove this section if there are not any general updates.
28+
29+
## Logging updates
30+
TODO: Remove this section if there are not any general updates.
31+
32+
## App size tool updates
33+
TODO: Remove this section if there are not any general updates.
34+
35+
## Changelog
36+
More details about changes and fixes are available in the DevTools
37+
[changelog](https://github.com/flutter/devtools/blob/master/CHANGELOG.md).
938

10-
- Retired the Analysis tab - (#4714)[https://github.com/flutter/devtools/pull/4714]
11-
- Added a new tab, Diff, to enable memory leak detection and troubleshooting
12-
by comparing heap snapshots, and providing insights about the number of
13-
instances, shallow size, retained size, and retaining
14-
paths - (#4714)[https://github.com/flutter/devtools/pull/4714]

packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,31 @@ This is draft for future release notes, that are going to land on
55

66
Dart & Flutter DevTools - A Suite of Performance Tools for Dart and Flutter
77

8-
# General updates
8+
## General updates
99
TODO: Remove this section if there are not any general updates.
1010

11-
# Inspector updates
11+
## Inspector updates
1212
TODO: Remove this section if there are not any general updates.
1313

14-
# Performance updates
14+
## Performance updates
1515
TODO: Remove this section if there are not any general updates.
1616

17-
# CPU profiler updates
17+
## CPU profiler updates
1818
TODO: Remove this section if there are not any general updates.
1919

20-
# Memory updates
20+
## Memory updates
2121
TODO: Remove this section if there are not any general updates.
2222

23-
# Debugger updates
23+
## Debugger updates
2424
TODO: Remove this section if there are not any general updates.
2525

26-
# Network profiler updates
26+
## Network profiler updates
2727
TODO: Remove this section if there are not any general updates.
2828

29-
# Logging updates
29+
## Logging updates
3030
TODO: Remove this section if there are not any general updates.
3131

32-
# App size tool updates
32+
## App size tool updates
3333
TODO: Remove this section if there are not any general updates.
3434

3535
## Changelog

tool/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ Make sure:
66
1. You have a local checkout of the Dart SDK
77
- (for getting started instructions, see [sdk/CONTRIBUTING.md](https://github.com/dart-lang/sdk/blob/main/CONTRIBUTING.md)).
88
2. Ensure your `.bashrc` sets `$LOCAL_DART_SDK`
9-
10-
```shell
9+
10+
```shell
1111
DART_SDK_REPO_DIR=<Path to cloned dart sdk>
1212
export LOCAL_DART_SDK=$DART_SDK_REPO_DIR/sdk
1313
```
1414
3. The local checkout is at `main` branch:
1515
- `git rebase-update`.
1616
4. Your Flutter version is equal to latest candidate release branch:
1717
- Run `./tool/update_flutter_sdk.sh --local` from the main devtools directory.
18-
5. You have goma [configured](http://go/ma-mac-setup).
18+
5. You have goma [configured](http://go/ma-mac-setup).
1919

2020
### Prepare the release
2121

@@ -69,7 +69,7 @@ These packages always have their version numbers updated in lock, so we don't ha
6969
intended to do the bulk of the work, but still needs manual review.
7070
* Verify
7171
* that the version for the CHANGELOG entry was correctly generated
72-
* that the entries don't have any syntax errors.
72+
* that the entries don't have any syntax errors.
7373

7474
#### Push the local branch
7575

@@ -79,7 +79,7 @@ NEW_DEVTOOLS_VERSION=2.7.0 # Change this to the new version
7979

8080
```shell
8181
git add . && \
82-
git commit -m Prepare for $NEW_DEVTOOLS_VERSION release. && \
82+
git commit -m "Prepare for $NEW_DEVTOOLS_VERSION release." && \
8383
git push origin release_$NEW_DEVTOOLS_VERSION;
8484
```
8585

@@ -168,7 +168,7 @@ From the git GUI tool or from github.com directly:
168168
./tools/build.py -mrelease -ax64 create_sdk;
169169
```
170170
171-
- Verify that running `dart devtools` launches the version of DevTools you just released.
171+
- Verify that running `dart devtools` launches the version of DevTools you just released.
172172
- for OSX
173173
```shell
174174
xcodebuild/ReleaseX64/dart-sdk/bin/dart devtools
@@ -179,7 +179,7 @@ From the git GUI tool or from github.com directly:
179179
```
180180
181181
- If the version of DevTools you just published to CIPD loads properly
182-
182+
183183
> You may need to hard reload and clear your browser cache in order to see the changes.
184184
185185
- push up the SDK CL for review.
@@ -203,13 +203,13 @@ Release notes should contain details about the user-facing changes included in t
203203
204204
These notes are shown directly in DevTools when a user opens a new version of DevTools.
205205
206-
1. Request the team to verify their important user facing changes are documented in
206+
1. Request the team to verify their important user facing changes are documented in
207207
[release-notes-next.md][1].
208208
209209
2. See the release notes
210210
[README.md](https://github.com/flutter/devtools/blob/master/packages/devtools_app/lib/src/framework/release_notes/README.md)
211211
for details on where to add DevTools release notes to Flutter website and how to test them.
212-
212+
213213
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
214214
draft for the next release.
215215

0 commit comments

Comments
 (0)