Skip to content

Commit

Permalink
[ci] Roll repo tooling and add readme-check (flutter#1667)
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartmorgan authored Apr 30, 2022
1 parent cd0a20b commit a539261
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .ci/scripts/prepare_tool.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ git fetch origin master

# Pinned version of the plugin tools, to avoid breakage in this repository
# when pushing updates from flutter/plugins.
dart pub global activate flutter_plugin_tools 0.8.2+1
dart pub global activate flutter_plugin_tools 0.8.4
12 changes: 12 additions & 0 deletions .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,18 @@ task:
license_script: dart pub global run flutter_plugin_tools license-check
analyze_script: ./script/tool_runner.sh analyze --custom-analysis=script/configs/custom_analysis.yaml
pubspec_script: ./script/tool_runner.sh pubspec-check
readme_script:
- ./script/tool_runner.sh readme-check
# Re-run with --require-excerpts, skipping packages that still need
# to be converted. Once https://github.com/flutter/flutter/issues/102679
# has been fixed, this can be removed and there can just be a single
# run with --require-excerpts and no exclusions.
- ./script/tool_runner.sh readme-check --require-excerpts --exclude=script/configs/temp_exclude_excerpt.yaml
- name: readme_excerpts
env:
CIRRUS_CLONE_SUBMODULES: true
script: ./script/tool_runner.sh update-excerpts --fail-on-change

# Does a sanity check that packages at least pass analysis on the N-1 and N-2
# versions of Flutter stable if the package claims to support that version.
# This is to minimize accidentally making changes that break old versions
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
with:
fetch-depth: 0 # Fetch all history so the tool can get all the tags to determine version.
- name: Set up tools
run: dart pub global activate flutter_plugin_tools 0.8.2+1
run: dart pub global activate flutter_plugin_tools 0.8.4

# # This workflow should be the last to run. So wait for all the other tests to succeed.
- name: Wait on all tests
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "site-shared"]
path = site-shared
url = https://github.com/dart-lang/site-shared
4 changes: 2 additions & 2 deletions packages/flutter_markdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ formatted output of the Markdown widget. For example, in the following Markdown
widget constructor, a text string with a smiley face emoji is passed in as the
source Markdown data.

```
```dart
Markdown(
controller: controller,
selectable: true,
Expand All @@ -100,7 +100,7 @@ auto-links, and strike-through. To include the inline emoji tag syntax
while maintaining the default GitHub flavored Markdown behavior, define
an extension set that combines EmojiSyntax with ExtensionSet.gitHubFlavored.

```
```dart
import 'package:markdown/markdown.dart' as md;
Markdown(
Expand Down
19 changes: 19 additions & 0 deletions script/configs/temp_exclude_excerpt.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Packages that have not yet adopted code-excerpt.
#
# This only exists to allow incrementally adopting the new requirement.
# Packages shoud never be added to this list.

# TODO(stuartmorgan): Remove everything from this list. See
# https://github.com/flutter/flutter/issues/102679
- cross_file
- css_colors
- extension_google_sign_in_as_googleapis_auth
- flutter_image
- flutter_markdown
- go_router
- go_router_builder
- multicast_dns
- palette_generator
- pigeon
- pointer_interceptor
- rfw
1 change: 1 addition & 0 deletions site-shared
Submodule site-shared added at 8c92e5
2 changes: 1 addition & 1 deletion third_party/packages/cupertino_icons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ https://pub.dev/packages/cupertino_icons

[![pub package](https://img.shields.io/pub/v/cupertino_icons.svg)](https://pub.dev/packages/cupertino_icons)

```
```yaml
dependencies:
cupertino_icons: ^<latest-version>
```
Expand Down

0 comments on commit a539261

Please sign in to comment.