Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[github actions] rewrite cherry pick template #144065

Merged
merged 5 commits into from
Mar 2, 2024

Conversation

XilaiZhang
Copy link
Contributor

@XilaiZhang XilaiZhang commented Feb 23, 2024

Context: @godofredoc pointed out that the fields in the PR template could be simplified and redesigned. Synced with @itsjustkevin and Kevin come up with changes in this doc which would improve the cherry pick template.

Github only supports a limited number of formatting options. This PR uses some workarounds and makes the following changes:

  1. use divider to replace text area since Github markdown doesn't support text area
  2. remove <pre> tags so texts can wrap around
  3. use headings over bold
  4. use task lists to identify the starting points of user answers

An example cherry pick template would look like this after the change.

@XilaiZhang
Copy link
Contributor Author

friendly ping, would be great if I can get a review on this PR. Thank you!


**To fill in the form, you can edit this PR description and type your answers after the 'My Answer' keywords. <br>
A flutter domain expert will evaluate this cherry pick request shortly after ALL questions are answered.**
---
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't need dividers, when using an H2(##) dividers are built in.

However, we may want to remove them completely and change the headings to H3(###) to still provide visual space without adding clutter.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, changed to H3 and removed dividers

.github/PR_TEMPLATE/PULL_REQUEST_CP_TEMPLATE.md Outdated Show resolved Hide resolved

- [ ] My answer:
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of using - [ ] My answer: would it be more readable to add generic text to be replaced? The template leaves me to assume that these are checklist items which confuse me as a user.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, replaced with texts placeholders

@XilaiZhang
Copy link
Contributor Author

XilaiZhang commented Feb 28, 2024

Thanks for the suggestions! The updated template will look something like this now

@XilaiZhang
Copy link
Contributor Author

friendly ping, would be great if I can get another review on this PR. Thank you!

@itsjustkevin
Copy link
Contributor

Impact_description has an underscore, it’s inconsistent with the rest of the headings, otherwise LGTM.


</pre>
### impact_description:
Copy link
Contributor

Choose a reason for hiding this comment

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

Match this to the other headings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point! updated

@XilaiZhang XilaiZhang added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 2, 2024
@auto-submit auto-submit bot merged commit 09b7a1c into flutter:master Mar 2, 2024
29 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2024
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Mar 2, 2024
flutter/flutter@ba719bc...65cd84b

2024-03-02 [email protected] Roll Flutter Engine from 8ef8543d6001 to 2706c732b22a (1 revision) (flutter/flutter#144493)
2024-03-02 [email protected] [github actions] rewrite cherry pick template (flutter/flutter#144065)
2024-03-01 [email protected] Roll Flutter Engine from 2a5a9a6dead0 to 8ef8543d6001 (1 revision) (flutter/flutter#144480)
2024-03-01 [email protected] Roll Packages from 6d02f03 to a9c68b8 (5 revisions) (flutter/flutter#144477)
2024-03-01 [email protected] Fix `showDateRangePicker` is missing `dartpad` tag and cleanup (flutter/flutter#144475)

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],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
LouiseHsu pushed a commit to LouiseHsu/packages that referenced this pull request Mar 7, 2024
flutter/flutter@ba719bc...65cd84b

2024-03-02 [email protected] Roll Flutter Engine from 8ef8543d6001 to 2706c732b22a (1 revision) (flutter/flutter#144493)
2024-03-02 [email protected] [github actions] rewrite cherry pick template (flutter/flutter#144065)
2024-03-01 [email protected] Roll Flutter Engine from 2a5a9a6dead0 to 8ef8543d6001 (1 revision) (flutter/flutter#144480)
2024-03-01 [email protected] Roll Packages from 6d02f03 to a9c68b8 (5 revisions) (flutter/flutter#144477)
2024-03-01 [email protected] Fix `showDateRangePicker` is missing `dartpad` tag and cleanup (flutter/flutter#144475)

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],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 14, 2024
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
flutter/flutter@ba719bc...65cd84b

2024-03-02 [email protected] Roll Flutter Engine from 8ef8543d6001 to 2706c732b22a (1 revision) (flutter/flutter#144493)
2024-03-02 [email protected] [github actions] rewrite cherry pick template (flutter/flutter#144065)
2024-03-01 [email protected] Roll Flutter Engine from 2a5a9a6dead0 to 8ef8543d6001 (1 revision) (flutter/flutter#144480)
2024-03-01 [email protected] Roll Packages from 6d02f03 to a9c68b8 (5 revisions) (flutter/flutter#144477)
2024-03-01 [email protected] Fix `showDateRangePicker` is missing `dartpad` tag and cleanup (flutter/flutter#144475)

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],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants