Skip to content

Display a report section on uncaught dartdoc tool failure. #5003

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

Merged
merged 4 commits into from
Aug 12, 2021

Conversation

isoos
Copy link
Collaborator

@isoos isoos commented Aug 4, 2021

@isoos isoos requested review from jonasfj and sigurdm August 4, 2021 15:45
@google-cla google-cla bot added the cla: yes label Aug 4, 2021
Copy link
Contributor

@sigurdm sigurdm left a comment

Choose a reason for hiding this comment

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

LGTM

job,
_emptyReport(
title: 'Failed to run dartdoc',
description: 'The dartdoc process timed out.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have a way to indicate the time it took? Should we?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is a tricky one: we have dartdoc runs that neither compete, nor time out (the timeout doesn't kill the process). Once we use the proper kill signal to do it (in this new release), I hope this class of error is gone and we can remove this block.

title: title,
description: description,
grantedPoints: 0,
maxPoints: 10,
Copy link
Contributor

Choose a reason for hiding this comment

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

Is maxPoints 10 the right thing here? Maybe it doesn't really matter...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, this is the score of the documentation block from pana.

Copy link
Contributor

@sigurdm sigurdm left a comment

Choose a reason for hiding this comment

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

LGTM

@isoos isoos merged commit f6875ea into dart-lang:master Aug 12, 2021
@isoos isoos deleted the dartdoc-timeout-info branch August 12, 2021 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants