Skip to content

Commit b25118a

Browse files
authored
Rename ecosystem testing package to canary (#323)
Makes more sense than `quest` :) Also some minor changes to `trebuchet`. --- - [x] I’ve reviewed the contributor guide and applied the relevant portions to this PR. <details> <summary>Contribution guidelines:</summary><br> - See our [contributor guide](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md) for general expectations for PRs. - Larger or significant changes should be discussed in an issue before creating a PR. - Contributions to our repos should follow the [Dart style guide](https://dart.dev/guides/language/effective-dart) and use `dart format`. - Most changes should add an entry to the changelog and may need to [rev the pubspec package version](https://github.com/dart-lang/sdk/blob/main/docs/External-Package-Maintenance.md#making-a-change). - Changes to packages require [corresponding tests](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md#Testing). Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback. </details>
1 parent b4b2a43 commit b25118a

17 files changed

+140
-100
lines changed

.github/ISSUE_TEMPLATE/canary.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: "package:canary"
3+
about: "Create a bug or file a feature request against package:canary."
4+
labels: "package:canary"
5+
---

.github/test_repos/repos.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "../../pkgs/quest/schema.json",
2+
"$schema": "../../pkgs/canary/schema.json",
33
"https://github.com/mosuem/my_app_old_web": {
44
"level": "analyze"
55
},

.github/workflows/ecosystem_test.yaml .github/workflows/canary.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Ecosystem test
1+
name: Canary
22

33
on:
44
workflow_call:
@@ -14,7 +14,7 @@ on:
1414
required: false
1515

1616
jobs:
17-
update_and_test:
17+
test:
1818
runs-on: ubuntu-latest
1919
steps:
2020
- name: Checkout repository
@@ -28,16 +28,16 @@ jobs:
2828

2929
- run: echo "${{ toJSON(github.event.pull_request.labels.*.name) }}"
3030

31-
- name: Install firehose
32-
run: dart pub global activate -s path pkgs/quest
31+
- name: Install local version of `package:canary`
32+
run: dart pub global activate -s path pkgs/canary
3333
if: ${{ inputs.local_debug }}
3434

35-
- run: dart pub global activate -s git https://github.com/dart-lang/ecosystem.git --git-ref main --git-path pkgs/quest
35+
- run: dart pub global activate -s git https://github.com/dart-lang/ecosystem.git --git-ref main --git-path pkgs/canary
3636
if: ${{ !inputs.local_debug }}
3737

3838
- name: Update package and test
3939
run: |
40-
dart pub global run quest ${{ inputs.repos_file }} ${{ github.repositoryUrl }} ${{ github.head_ref || github.ref_name }} "${{ toJSON(github.event.pull_request.labels.*.name) }}"
40+
dart pub global run canary ${{ inputs.repos_file }} ${{ github.repositoryUrl }} ${{ github.head_ref || github.ref_name }} "${{ toJSON(github.event.pull_request.labels.*.name) }}"
4141
env:
4242
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4343

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Ecosystem test:Internal
1+
name: Canary:Internal
22

33
on:
44
pull_request:
@@ -7,7 +7,7 @@ on:
77

88
jobs:
99
test_ecosystem:
10-
uses: ./.github/workflows/ecosystem_test.yaml
10+
uses: ./.github/workflows/canary.yaml
1111
with:
1212
repos_file: .github/test_repos/repos.json
1313
local_debug: true

.github/workflows/quest.yml .github/workflows/canary_test.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
name: package:quest
1+
name: package:canary
22

33
permissions: read-all
44

55
on:
66
pull_request:
77
branches: [ main ]
88
paths:
9-
- '.github/workflows/quest.yml'
10-
- 'pkgs/quest/**'
9+
- '.github/workflows/canary.yml'
10+
- 'pkgs/canary/**'
1111
push:
1212
branches: [ main ]
1313
paths:
14-
- '.github/workflows/quest.yml'
15-
- 'pkgs/quest/**'
14+
- '.github/workflows/canary.yml'
15+
- 'pkgs/canary/**'
1616
schedule:
1717
- cron: '0 0 * * 0' # weekly
1818

1919
defaults:
2020
run:
21-
working-directory: pkgs/quest
21+
working-directory: pkgs/canary
2222

2323
env:
2424
GH_TOKEN: ${{ github.token }}

.github/workflows/post_summaries.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
workflows:
99
- Publish:Internal
1010
- Health:Internal
11-
- Ecosystem test:Internal
11+
- Canary:Internal
1212
types:
1313
- completed
1414

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This repository is home to general Dart Ecosystem tools and packages.
99
| Package | Description | Version |
1010
| --- | --- | --- |
1111
| [blast_repo](pkgs/blast_repo/) | A tool to bulk validate and fix GitHub repos. | |
12+
| [canary](pkgs/canary/) | Test package upgrades against the ecosystem. | |
1213
| [corpus](pkgs/corpus/) | A tool to calculate the API usage for a package. | |
1314
| [dart_flutter_team_lints](pkgs/dart_flutter_team_lints/) | An analysis rule set used by the Dart and Flutter teams. | [![pub package](https://img.shields.io/pub/v/dart_flutter_team_lints.svg)](https://pub.dev/packages/dart_flutter_team_lints) |
1415
| [firehose](pkgs/firehose/) | A tool to automate publishing of Pub packages from GitHub actions. | [![pub package](https://img.shields.io/pub/v/firehose.svg)](https://pub.dev/packages/firehose) |
File renamed without changes.
File renamed without changes.

pkgs/quest/README.md pkgs/canary/README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Quest: Ecosystem Testing for Dart Packages
2-
Embark your package on a quest of testing against a suite of applications. This helps identify potential breaking changes introduced by package updates, ensuring seamless integration across the ecosystem.
1+
# Canary: Ecosystem Testing for Dart Packages
2+
Before publishing, send a canary out to test a package against a suite of applications. This helps identify potential breaking changes introduced by package updates, ensuring seamless integration across the ecosystem.
33

44
## What does it do?
55
It checks if your package upgrade would result in failures in the ecosystem. This is achieved by running the following pseudocode:
@@ -35,9 +35,9 @@ for (final app in applicationSuite) {
3535
}
3636
```
3737

38-
2. Add a workflow file with the following contents:
38+
2. Add a workflow file `canary.yaml` with the following contents:
3939
```yaml
40-
name: Ecosystem test
40+
name: Canary
4141

4242
on:
4343
pull_request:
@@ -46,12 +46,12 @@ on:
4646

4747
jobs:
4848
test_ecosystem:
49-
uses: dart-lang/ecosystem/.github/workflows/ecosystem_test.yaml@main
49+
uses: dart-lang/ecosystem/.github/workflows/canary.yaml@main
5050
with:
5151
repos_file: .github/test_repos/repos.json
5252
```
5353
54-
3. To show the markdown result as a comment, also add a workflow file
54+
3. To show the markdown result as a comment, also add a workflow file `post_summaries.yaml`
5555
```yaml
5656
name: Comment on the pull request
5757
@@ -60,9 +60,7 @@ on:
6060
# do things like create comments on the PR, even if the original workflow couldn't.
6161
workflow_run:
6262
workflows:
63-
- Health
64-
- Publish
65-
- Ecosystem test
63+
- Canary
6664
types:
6765
- completed
6866
File renamed without changes.

0 commit comments

Comments
 (0)