Skip to content

[repo] Adjust error message layout for repo checks #5241

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 7, 2023
Merged

[repo] Adjust error message layout for repo checks #5241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abe6d57
Tweak error message
Piinks Oct 26, 2023
b61d09e
Rollback over tweaking
Piinks Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions script/tool/lib/src/version_check_command.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
}
}
Expand All @@ -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';
}
Expand Down
7 changes: 5 additions & 2 deletions script/tool/test/version_check_command_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ packages/plugin/example/lib/foo.dart
expect(
output,
containsAllInOrder(<Matcher>[
contains('No CHANGELOG change found'),
contains('No CHANGELOG change found.\nIf'),
contains('plugin:\n'
' Missing CHANGELOG change'),
]),
Expand Down Expand Up @@ -1222,7 +1222,10 @@ packages/plugin/lib/plugin.dart
expect(
output,
containsAllInOrder(<Matcher>[
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'),
]),
Expand Down