firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reland "Use dartpad's main channel for master/main docs (#144329)" (#144431)

Browse Source 
Fix is in the second commit. The logic here went out of sync with the logic in the snippets generator from https://github.com/flutter/assets-for-api-docs, whose version was bumped as part of this change.
This commit is contained in:
Michael Goderbauer 2024-02-29 15:10:53 -08:00 committed by GitHub
parent f3ce9d2fcb
commit e41ffcb742
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dev/bots/docs.sh
View File

@ -116,7 +116,7 @@ function generate_docs() {
# Install and activate the snippets tool, which resides in the # Install and activate the snippets tool, which resides in the
# assets-for-api-docs repo: # assets-for-api-docs repo:
# https://github.com/flutter/assets-for-api-docs/tree/master/packages/snippets # https://github.com/flutter/assets-for-api-docs/tree/master/packages/snippets
"$DART" pub global activate snippets 0.4.0 "$DART" pub global activate snippets 0.4.2
# This script generates a unified doc set, and creates # This script generates a unified doc set, and creates
# a custom index.html, placing everything into DOC_DIR. # a custom index.html, placing everything into DOC_DIR.

2
dev/snippets/config/skeletons/dartpad-sample.html
View File

@ -13,7 +13,7 @@
</p> </p>
</div> </div>
<iframe class="snippet-dartpad" <iframe class="snippet-dartpad"
src="https://dartpad.dev/embed-flutter.html?split=60&amp;run=true&amp;sample_id={{id}}&amp;sample_channel={{channel}}&amp;channel={{channel}}"> src="https://dartpad.dev/embed-flutter.html?split=60&amp;run=true&amp;sample_id={{id}}&amp;channel={{channel}}">
</iframe> </iframe>
</div> </div>
{@end-inject-html} {@end-inject-html}

8
dev/tools/create_api_docs.dart
View File

@ -742,15 +742,15 @@ class DartdocGenerator {
// Check a "dartpad" example, any one will do, and check for the correct URL // Check a "dartpad" example, any one will do, and check for the correct URL
// arguments. // arguments.
// Just use "master" for any branch other than the LUCI_BRANCH. // Just use "main" for any branch other than "stable", just like it is done
// in the snippet generator at https://github.com/flutter/assets-for-api-docs/blob/cc56972b8f03552fc5f9f9f1ef309efc6c93d7bc/packages/snippets/lib/src/snippet_generator.dart#L104.
final String? luciBranch = platform.environment['LUCI_BRANCH']?.trim(); final String? luciBranch = platform.environment['LUCI_BRANCH']?.trim();
final String expectedBranch = luciBranch != null && luciBranch.isNotEmpty ? luciBranch : 'master'; final String expectedChannel = luciBranch == 'stable' ? 'stable' : 'main';
final List<String> argumentRegExps = <String>[ final List<String> argumentRegExps = <String>[
r'split=\d+', r'split=\d+',
r'run=true', r'run=true',
r'sample_id=widgets\.Listener\.\d+', r'sample_id=widgets\.Listener\.\d+',
'sample_channel=$expectedBranch', 'channel=$expectedChannel',
'channel=$expectedBranch',
]; ];
for (final String argumentRegExp in argumentRegExps) { for (final String argumentRegExp in argumentRegExps) {
_sanityCheckExample( _sanityCheckExample(

2
dev/tools/test/create_api_docs_test.dart
View File

@ -441,7 +441,7 @@ void main() {
</code> </code>
</pre> </pre>
'''); ''');
const String queryParams = 'split=1&run=true&sample_id=widgets.Listener.123&sample_channel=master&channel=master'; const String queryParams = 'split=1&run=true&sample_id=widgets.Listener.123&channel=main';
widgetsDir.childFile('Listener-class.html').writeAsStringSync(''' widgetsDir.childFile('Listener-class.html').writeAsStringSync('''
<iframe class="snippet-dartpad" src="https://dartpad.dev/embed-flutter.html?$queryParams"> <iframe class="snippet-dartpad" src="https://dartpad.dev/embed-flutter.html?$queryParams">
</iframe> </iframe>