Give channel descriptions in flutter channel, use branch instead of upstream for channel name
#126936
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9259260 to
38550ca
Compare
2 tasks
d781ec9 to
8d01a6a
Compare
f6186f4 to
a95a836
Compare
| ); | ||
| } | ||
| try { | ||
| await processUtils.run( | ||
| // The `--` bit (because it's followed by nothing) means that we don't actually change | ||
| // anything in the working tree, which avoids the need to first go into detached HEAD mode. |
There was a problem hiding this comment.
ahh, thanks for the comment
| 'main', | ||
| 'beta', | ||
| 'stable', | ||
| }; | ||
|
|
||
| const Map<String, String> kChannelDescriptions = <String, String>{ | ||
| 'master': 'tip of tree, for contributors', |
There was a problem hiding this comment.
I've found several contributors confused by the term "tip of tree", or "tree" in general with regards to a repository. What about: "latest development branch, for contributors"?
| @@ -709,8 +717,8 @@ class GitTagVersion { | |||
| String gitRef = 'HEAD' | |||
| }) { | |||
| if (fetchTags) { | |||
| final String channel = _runGit('git rev-parse --abbrev-ref HEAD', processUtils, workingDirectory); | |||
| if (channel == 'dev' || channel == 'beta' || channel == 'stable') { | |||
| final String channel = _runGit('git symbolic-ref --short HEAD', processUtils, workingDirectory); | |||
There was a problem hiding this comment.
for posterity, was git rev-parse --abbrev-ref HEAD giving us the wrong string?
There was a problem hiding this comment.
Also, looks like this is a new git sub-command after an internal refactor. I wonder if all of our users will have it in their git? https://git-scm.com/docs/git-symbolic-ref#_notes
There was a problem hiding this comment.
Well, it was at least around in 2011, so I'm guessing it should be fine https://stackoverflow.com/questions/4986000/whats-the-recommended-usage-of-a-git-symbolic-reference
There was a problem hiding this comment.
As far as I can tell what we did before was just wrong and this command has existed for ages.
But it's git.
So who knows.
I certainly cannot say with certainty that this is correct.
|
auto label is removed for flutter/flutter, pr: 126936, due to - This commit is not mergeable and has conflicts. Please rebase your PR and fix all the conflicts. |
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 24, 2023
…stead of upstream for channel name (flutter/flutter#126936)
auto-submit bot
pushed a commit
to flutter/packages
that referenced
this pull request
May 24, 2023
flutter/flutter@f86c529...216605b 2023-05-24 [email protected] Roll Flutter Engine from aba9dc4640c2 to eebcf36cd38f (3 revisions) (flutter/flutter#127458) 2023-05-24 [email protected] Roll Flutter Engine from 76afb431a740 to aba9dc4640c2 (1 revision) (flutter/flutter#127453) 2023-05-24 [email protected] Roll Flutter Engine from fc6df9512aa2 to 76afb431a740 (3 revisions) (flutter/flutter#127445) 2023-05-23 49699333+dependabot[bot]@users.noreply.github.com Bump actions/labeler from 6b107e7a7ee5e054e0bcce60de5181d21e2f00fb to 2713f7303c96cb1e69627957ec16eea0fd7f94a4 (flutter/flutter#127438) 2023-05-23 [email protected] Roll Flutter Engine from 3535e0d301dd to fc6df9512aa2 (1 revision) (flutter/flutter#127440) 2023-05-23 [email protected] Migrates android semanitcs integration to integration test (flutter/flutter#127128) 2023-05-23 [email protected] Roll Flutter Engine from 23b04314d5d2 to 3535e0d301dd (3 revisions) (flutter/flutter#127428) 2023-05-23 [email protected] Roll Flutter Engine from ccf50f344d5d to 23b04314d5d2 (2 revisions) (flutter/flutter#127421) 2023-05-23 [email protected] Give channel descriptions in `flutter channel`, use branch instead of upstream for channel name (flutter/flutter#126936) 2023-05-23 [email protected] Avoid catching errors in TextPainter tests (flutter/flutter#127307) 2023-05-23 [email protected] [flutter_tools] delete entitlements files after copying to macos build dir (flutter/flutter#127417) 2023-05-23 [email protected] Roll Flutter Engine from a6e37bde65fd to ccf50f344d5d (7 revisions) (flutter/flutter#127416) 2023-05-23 [email protected] modal bottom sheet barrier label (flutter/flutter#126431) 2023-05-23 [email protected] Fix the breaking of multi-code-unit characters in obscure mode (flutter/flutter#123366) 2023-05-23 [email protected] Roll Flutter Engine from 168b0bf3f70d to a6e37bde65fd (1 revision) (flutter/flutter#127397) 2023-05-23 [email protected] Revert "Log all output of ios-deploy" (flutter/flutter#127405) 2023-05-23 [email protected] Roll Packages from 83959fb to d449a17 (6 revisions) (flutter/flutter#127394) 2023-05-23 [email protected] Log all output of ios-deploy (flutter/flutter#127222) 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
CaseyHillers
pushed a commit
to CaseyHillers/flutter
that referenced
this pull request
May 24, 2023
… upstream for channel name (flutter#126936) ## How we determine the channel name Historically, we used the current branch's upstream to figure out the current channel name. I have no idea why. I traced it back to https://github.com/flutter/flutter/pull/446/files where @abarth implement this and I reviewed that PR and left no comment on it at the time. I think this is confusing. You can be on a branch and it tells you that your channel is different. That seems weird. This PR changes the logic to uses the current branch as the channel name. ## How we display channels The main reason this PR exists is to add channel descriptions to the `flutter channel` list: ``` ianh@burmese:~/dev/flutter/packages/flutter_tools$ flutter channel Flutter channels: master (tip of tree, for contributors) main (tip of tree, follows master channel) beta (updated monthly, recommended for experienced users) stable (updated quarterly, for new users and for production app releases) * foo_bar Currently not on an official channel. ianh@burmese:~/dev/flutter/packages/flutter_tools$ ``` ## Other changes I made a few other changes while I was at it: * If you're not on an official channel, we used to imply `--show-all`, but now we don't, we just show the official channels plus yours. This avoids flooding the screen in the case the user is on a weird channel and just wants to know what channel they're on. * I made the tool more consistent about how it handles unofficial branches. Now it's always `[user branch]`. * I slightly adjusted how unknown versions are rendered so it's clearer the version is unknown rather than just having the word "Unknown" floating in the output without context. * Simplified some of the code. * Made some of the tests more strict (checking all output rather than just some aspects of it). * Changed the MockFlutterVersion to implement the FlutterVersion API more strictly. * I made sure we escape the output to `.metadata` to avoid potential injection bugs (previously we just inlined the version and channel name verbatim with no escaping, which is super sketchy). * Tweaked the help text for the `downgrade` command to be clearer. * Removed some misleading text in some error messages. * Made the `.metadata` generator consistent with the template file. * Removed some obsolete code to do with the `dev` branch. ## Reviewer notes I'm worried that there are implications to some of these changes that I am not aware of, so please don't assume I know what I'm doing when reviewing this code. :-)
This was referenced May 25, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 16, 2023
…stead of upstream for channel name (flutter/flutter#126936)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 17, 2023
…stead of upstream for channel name (flutter/flutter#126936)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 17, 2023
…stead of upstream for channel name (flutter/flutter#126936)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 17, 2023
…stead of upstream for channel name (flutter/flutter#126936)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
How we determine the channel name
Historically, we used the current branch's upstream to figure out the current channel name. I have no idea why. I traced it back to https://github.com/flutter/flutter/pull/446/files where @abarth implement this and I reviewed that PR and left no comment on it at the time.
I think this is confusing. You can be on a branch and it tells you that your channel is different. That seems weird.
This PR changes the logic to uses the current branch as the channel name.
How we display channels
The main reason this PR exists is to add channel descriptions to the
flutter channellist:Other changes
I made a few other changes while I was at it:
--show-all, but now we don't, we just show the official channels plus yours. This avoids flooding the screen in the case the user is on a weird channel and just wants to know what channel they're on.[user branch]..metadatato avoid potential injection bugs (previously we just inlined the version and channel name verbatim with no escaping, which is super sketchy).downgradecommand to be clearer..metadatagenerator consistent with the template file.devbranch.Reviewer notes
I'm worried that there are implications to some of these changes that I am not aware of, so please don't assume I know what I'm doing when reviewing this code. :-)