Skip to content

Commit 22e3174

Browse files
authored
Update release note generation to match new Jaspr architecture (#9514)
1 parent 55e350a commit 22e3174

3 files changed

Lines changed: 17 additions & 43 deletions

File tree

packages/devtools_app/lib/src/framework/release_notes.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ bool debugTestReleaseNotes = false;
2727
// To load markdown from a staged flutter website, set this string to the url
2828
// from the flutter/website PR, which has a GitHub action that automatically
2929
// stages commits to firebase. Example:
30-
// https://flutter-docs-prod--pr8928-dt-notes-links-b0b33er1.web.app/tools/devtools/release-notes/release-notes-2.24.0-src.md.
30+
// https://flutter-docs-prod--pr12652-devtools-release-notes-2-52-3bbb8c0u.web.app/tools/devtools/release-notes/release-notes-2.52.0.md.
3131
String? _debugReleaseNotesUrl;
3232

3333
const releaseNotesKey = Key('release_notes');

packages/devtools_app/release_notes/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,10 @@ Clean up the drafted notes on your local `flutter/website` branch and open a PR.
7070
Once you push up your branch to `flutter/website` and open your PR,
7171
wait for the `github-actions` bot to stage your changes to Firebase.
7272
Open the link it comments and navigate to the release notes you want to test.
73-
Be sure to add `-src.md` to the url to get the raw json.
7473
The url should look something like:
7574

7675
```
77-
https://flutter-docs-prod--pr8928-dt-notes-links-b0b33er1.web.app/tools/devtools/release-notes/release-notes-2.24.0-src.md
76+
https://flutter-docs-prod--pr12652-devtools-release-notes-2-52-3bbb8c0u.web.app/tools/devtools/release-notes/release-notes-2.52.0.md
7877
```
7978
8079
- Copy this url and set `_debugReleaseNotesUrl` in

tool/lib/commands/release_notes_helper.dart

Lines changed: 15 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -107,27 +107,10 @@ class ReleaseNotesCommand extends Command {
107107
}
108108

109109
// Write the 'release-notes-<x.y.z>.md' file.
110-
File(
111-
p.join(
112-
websiteReleaseNotesDir.path,
113-
'release-notes-$releaseNotesVersion.md',
114-
),
115-
)
116-
..createSync()
117-
..writeAsStringSync('''---
118-
short-title: $releaseNotesVersion release notes
119-
description: Release notes for Dart and Flutter DevTools version $releaseNotesVersion.
120-
toc: false
121-
---
122-
123-
{% include ./release-notes-$releaseNotesVersion-src.md %}
124-
''', flush: true);
125-
126-
// Create the 'release-notes-<x.y.z>-src.md' file.
127-
final releaseNotesSrcMd = File(
110+
final releaseNotesMd = File(
128111
p.join(
129112
websiteReleaseNotesDir.path,
130-
'release-notes-$releaseNotesVersion-src.md',
113+
'release-notes-$releaseNotesVersion.md',
131114
),
132115
)..createSync();
133116

@@ -159,30 +142,22 @@ toc: false
159142
}
160143
}
161144

162-
// Write the 'release-notes-<x.y.z>-src.md' file, including any updates for
145+
final metadataHeader = '''---
146+
title: DevTools $releaseNotesVersion release notes
147+
short-title: $releaseNotesVersion release notes
148+
breadcrumb: $releaseNotesVersion
149+
toc: false
150+
---
151+
152+
''';
153+
154+
// Write the 'release-notes-<x.y.z>.md' file, including any updates for
163155
// image paths.
164-
releaseNotesSrcMd.writeAsStringSync(
165-
srcLines.joinWithNewLine(),
156+
releaseNotesMd.writeAsStringSync(
157+
metadataHeader + srcLines.joinWithNewLine(),
166158
flush: true,
167159
);
168160

169-
// Write the 'devtools_releases.yml' file.
170-
final releasesYml = File(
171-
p.join(websiteRepoPath, 'src', '_data', 'devtools_releases.yml'),
172-
);
173-
if (!releasesYml.existsSync()) {
174-
throw FileSystemException(
175-
'The devtools_releases.yml file does not exist.',
176-
releasesYml.path,
177-
);
178-
}
179-
final releasesYmlContent = releasesYml.readAsStringSync().replaceFirst(
180-
'releases:',
181-
'''releases:
182-
- '$releaseNotesVersion\'''',
183-
);
184-
releasesYml.writeAsStringSync(releasesYmlContent, flush: true);
185-
186161
const firstPartInstructions =
187162
'Release notes successfully drafted in a local flutter/website branch. '
188163
'Please clean them up by deleting empty sections and fixing any '
@@ -192,7 +167,7 @@ toc: false
192167
$firstPartInstructions
193168
194169
cd $websiteRepoPath;
195-
code ${releaseNotesSrcMd.absolute.path}
170+
code ${releaseNotesMd.absolute.path}
196171
197172
Create a PR on the flutter/website repo when you are finished.
198173
''');

0 commit comments

Comments
 (0)