From fd4876ce450f786b17dfa5664526800e70b50401 Mon Sep 17 00:00:00 2001 From: Kate Lovett Date: Tue, 7 Nov 2023 14:40:35 -0600 Subject: [PATCH] [repo] Adjust error message layout for repo checks (#5241) This tweaks the errors messages that provide info like how to override a repo check for versioning or changelog updates. Basically added newlines, so the errors do not require scrolling far off to the right to get the message. --- .../tool/lib/src/version_check_command.dart | 23 ++++++++++--------- .../tool/test/version_check_command_test.dart | 7 ++++-- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/script/tool/lib/src/version_check_command.dart b/script/tool/lib/src/version_check_command.dart index c27a1ad33c44..81fa3eec5100 100644 --- a/script/tool/lib/src/version_check_command.dart +++ b/script/tool/lib/src/version_check_command.dart @@ -558,11 +558,12 @@ ${indentation}The first version listed in CHANGELOG.md is $fromChangeLog. } else { printError( 'No version change found, but the change to this package could ' - 'not be verified to be exempt from version changes according to ' - 'repository policy. If this is a false positive, please comment in ' - 'the PR to explain why the PR is exempt, and add (or ask your ' - 'reviewer to add) the "$_missingVersionChangeOverrideLabel" ' - 'label.'); + 'not be verified to be exempt\n' + 'from version changes according to repository policy.\n' + 'If this is a false positive, please comment in ' + 'the PR to explain why the PR\n' + 'is exempt, and add (or ask your reviewer to add) the ' + '"$_missingVersionChangeOverrideLabel" label.'); return 'Missing version change'; } } @@ -572,13 +573,13 @@ ${indentation}The first version listed in CHANGELOG.md is $fromChangeLog. logWarning('Ignoring lack of CHANGELOG update due to the ' '"$_missingChangelogChangeOverrideLabel" label.'); } else { - printError( - 'No CHANGELOG change found. If this PR needs an exemption from ' - 'the standard policy of listing all changes in the CHANGELOG, ' + printError('No CHANGELOG change found.\n' + 'If this PR needs an exemption from the standard policy of listing ' + 'all changes in the CHANGELOG,\n' 'comment in the PR to explain why the PR is exempt, and add (or ' - 'ask your reviewer to add) the ' - '"$_missingChangelogChangeOverrideLabel" label. Otherwise, ' - 'please add a NEXT entry in the CHANGELOG as described in ' + 'ask your reviewer to add) the\n' + '"$_missingChangelogChangeOverrideLabel" label.\n' + 'Otherwise, please add a NEXT entry in the CHANGELOG as described in ' 'the contributing guide.'); return 'Missing CHANGELOG change'; } diff --git a/script/tool/test/version_check_command_test.dart b/script/tool/test/version_check_command_test.dart index da864de409a9..13bee57785c0 100644 --- a/script/tool/test/version_check_command_test.dart +++ b/script/tool/test/version_check_command_test.dart @@ -961,7 +961,7 @@ packages/plugin/example/lib/foo.dart expect( output, containsAllInOrder([ - contains('No CHANGELOG change found'), + contains('No CHANGELOG change found.\nIf'), contains('plugin:\n' ' Missing CHANGELOG change'), ]), @@ -1222,7 +1222,10 @@ packages/plugin/lib/plugin.dart expect( output, containsAllInOrder([ - contains('No version change found'), + contains( + 'No version change found, but the change to this package could ' + 'not be verified to be exempt\n', + ), contains('plugin:\n' ' Missing version change'), ]),