Skip to content

Conversation

@nate-thegrate
Copy link
Contributor

Resolves #154628


As a contributor, I would expect resources related to testing to be located in the /docs/contributing/testing directory. This PR adds a page to that directory geared toward helping new contributors.


I've noticed that in team-framework triage meetings, comments along the lines of "could you take a look at the failing checks?" are a regular occurrence.

I believe we could save quite a bit of effort by changing this:

Understanding a LUCI build failure

to this:

Flutter wiki – How to fix failing checks

@github-actions github-actions bot added c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. team-infra Owned by Infrastructure team d: docs/ flutter/flutter/docs, for contributors labels Sep 4, 2024
@nate-thegrate

This comment was marked as resolved.

@Piinks Piinks requested a review from dkwingsmt September 24, 2024 22:09
@nate-thegrate
Copy link
Contributor Author

nate-thegrate commented Oct 2, 2024

@dkwingsmt thanks again for the advice & feedback! I updated the wiki page with "What to do:" sections as you suggested.

I also tried adding section headers for customer_testing and Linux Analyze, but I felt that it negatively impacted the flow of the document (being similar to the above sections would imply that they should both have their own "what to do" paragraph, except they both are resolved the same way: reading through the test output).

@chunhtai chunhtai requested a review from dkwingsmt October 8, 2024 19:09
@nate-thegrate nate-thegrate mentioned this pull request Oct 14, 2024
Copy link
Contributor

@dkwingsmt dkwingsmt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had some comments that I thought I gave, but actually they were pending! I'm so sorry.

In general this is looking awesome. I'll ask someone familiar with tech writing for the final review.

@nate-thegrate

This comment was marked as resolved.

@nate-thegrate nate-thegrate removed the request for review from christopherfujino October 22, 2024 22:06
Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, for the delay! This mostly looks pretty good, though there is one phrase that I find confusing.


A **tree-status** failure indicates that the main branch has problems
that should be addressed before anything else is merged in.
The result of this check usually goes back and forth a few times each day,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean: the result of this check usually "goes back and forth a few times"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant that the result alternates between "success" and "failure", often multiple times per day.

But after reading it over again, I agree that the wording isn't super clear. I'll try revising this section.

Copy link
Contributor Author

@nate-thegrate nate-thegrate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sfshaza2 thanks very much for the review!


A **tree-status** failure indicates that the main branch has problems
that should be addressed before anything else is merged in.
The result of this check usually goes back and forth a few times each day,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant that the result alternates between "success" and "failure", often multiple times per day.

But after reading it over again, I agree that the wording isn't super clear. I'll try revising this section.

@nate-thegrate
Copy link
Contributor Author

Hi Shams, this PR isn't urgent but I do believe you're the most qualified to evaluate this change :)

PTAL when you have a chance, thanks!

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! I have one tiny modification, and it's not a big deal at all.

@nate-thegrate nate-thegrate added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 13, 2024
@auto-submit auto-submit bot merged commit e77093b into flutter:master Nov 13, 2024
33 checks passed
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 13, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 14, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 14, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 14, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 14, 2024
@nate-thegrate nate-thegrate deleted the fix-checks-wiki-page branch November 14, 2024 18:48
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2024
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Nov 15, 2024
Roll Flutter from ed553d1 to 0e2d55e (40 revisions)

flutter/flutter@ed553d1...0e2d55e

2024-11-15 [email protected] Roll Packages from b9ac917 to b164be3 (4 revisions) (flutter/flutter#158986)
2024-11-15 [email protected] Label PRs with gradle and Android paths "platform-android" (flutter/flutter#158970)
2024-11-15 [email protected] Fix code asset copying logic in native asset code (flutter/flutter#158984)
2024-11-15 [email protected] Fix duplicate work in native assets release builds (flutter/flutter#158980)
2024-11-15 [email protected] Stop generate both `.kts` and non-`.kts` gradle files for a test project. (flutter/flutter#158965)
2024-11-15 [email protected] Further skip `native_assets_test`(s) that runs `flutter build apk`. (flutter/flutter#158966)
2024-11-15 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 4.2.1 to 4.2.2 (flutter/flutter#157473)
2024-11-15 [email protected] Try running historically flaky tests first to make `flutter build apk` health tests time out more often? (flutter/flutter#158967)
2024-11-15 [email protected] [ tool ] Don't throw StateError when DDS fails to start (flutter/flutter#158744)
2024-11-14 [email protected] Create merge_queue.md (flutter/flutter#158959)
2024-11-14 [email protected] Marks Mac_x64 hot_mode_dev_cycle_macos_target__benchmark to be flaky (flutter/flutter#158569)
2024-11-14 [email protected] Marks Mac_arm64 mac_desktop_impeller to be unflaky (flutter/flutter#158564)
2024-11-14 [email protected] [gen_l10n] When localizing a message, prefer placeholder definitions defined by the current locale rather than the template locale (flutter/flutter#153459)
2024-11-14 [email protected] feat: Include web 1.x.x in plugin template (flutter/flutter#156947)
2024-11-14 [email protected] hide members where possible (flutter/flutter#158492)
2024-11-14 [email protected] Move platform-specific log-reading implementation details from `ResidentRunner`/`FlutterDevice` to `DeviceLogReader` implementations (flutter/flutter#156181)
2024-11-14 [email protected] Updated document to clarify Clip Behaviour (flutter/flutter#157719)
2024-11-14 [email protected] Enable --verbose for android_plugin_skip_unsupported_test tests (flutter/flutter#158933)
2024-11-14 [email protected] Roll Packages from 26e123a to b9ac917 (5 revisions) (flutter/flutter#158938)
2024-11-14 [email protected] Add `dev_dependency` attribute to plugins in `.flutter-plugins-dependencies` (flutter/flutter#158009)
2024-11-14 [email protected] No longer pass `--verbose` to implicit `pub` calls when `flutter --verbose` is set. (flutter/flutter#158898)
2024-11-14 [email protected] Update triage flow chart for SVG packages (flutter/flutter#158670)
2024-11-14 [email protected] Add one MenuAnchor alignment test (flutter/flutter#158915)
2024-11-14 [email protected] Reland Add test for dynamic_content_color.0.dart (flutter/flutter#158547)
2024-11-14 [email protected] Roll Flutter Engine from e97b148e796d to 619804c0fbb7 (1 revision) (flutter/flutter#158905)
2024-11-14 [email protected] Roll Flutter Engine from 82940a9aa714 to e97b148e796d (1 revision) (flutter/flutter#158901)
2024-11-14 [email protected] Move explicit package dependencies to a feature flag (flutter/flutter#158016)
2024-11-14 [email protected] Try with `bringup: true` debugging why `flutter build apk` often times out. (flutter/flutter#158895)
2024-11-14 [email protected] Add constraint options to `SearchAnchor` suggestions builder (flutter/flutter#148856)
2024-11-14 [email protected] Adjusts the Hindi TimeOfDayFormat to display in a LTR orientation in localizations. (flutter/flutter#157998)
2024-11-14 [email protected] Fix update order of SliverAppBar (flutter/flutter#158159)
2024-11-13 [email protected] #154792 - CupertinoActionSheetAction cursor doesn't change to clickable on desktop (flutter/flutter#158470)
2024-11-13 [email protected] Adds a skip message for analyzer (flutter/flutter#158890)
2024-11-13 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Marks Mac_arm64_ios hot_mode_dev_cycle_ios__benchmark to be flaky (#158242)" (flutter/flutter#158891)
2024-11-13 [email protected] [SwiftPM] Move the logic for SwiftPM enablement to the platform project (flutter/flutter#158213)
2024-11-13 [email protected] Temporarily skip flutter build apk for native_assets tests. (flutter/flutter#158880)
2024-11-13 [email protected] docs: include Human Interface haptic information in HapticFeedback (flutter/flutter#158587)
2024-11-13 [email protected] Roll Flutter Engine from db3e5af2ca22 to 82940a9aa714 (2 revisions) (flutter/flutter#158799)
2024-11-13 [email protected] Stream the output of `flutter build` for debugging. (flutter/flutter#158757)
2024-11-13 [email protected] "Fix failing checks" wiki page for new contributors (flutter/flutter#154629)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.
...
@nate-thegrate nate-thegrate added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 26, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App c: contributor-productivity Team-specific productivity, code health, technical debt. d: docs/ flutter/flutter/docs, for contributors framework flutter/packages/flutter repository. See also f: labels. team-infra Owned by Infrastructure team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Flutter wiki] Resources for addressing failing checks

4 participants