NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Improve docs on automated tests#17040

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

QuLogic merged 1 commit intomatplotlib:masterfromtimhoffm:doc-test

Apr 17, 2020

Merged

Improve docs on automated tests#17040

QuLogic merged 1 commit intomatplotlib:masterfromtimhoffm:doc-test

Apr 17, 2020

Conversation

Copy link

Member

timhoffm commentedApr 5, 2020

PR Summary

Mention Azure pipelines
Add tips for finding the cause of failed tests.
Mention that Codecov and LGTM are for information only, i.e. not necessarily a blocker for merging.

Copy link

Member

QuLogic commentedApr 6, 2020

Do you also want to mention thatAzure has image artifacts if a tests fail?

Copy link

MemberAuthor

timhoffm commentedApr 7, 2020

Makes sense. Would you mind adding a description how to find these? I don't have a clear picture of that yet.

timhoffm commented

Apr 11, 2020

View reviewed changes

doc/devel/coding_guide.rst

		@@ -160,24 +160,36 @@ Merging
		A core dev should only champion one PR at a time and we should try to keep
		the flow of championed PRs reasonable.

		* Do not self merge, except for 'small' patches to un-break the CI or

Copy link

MemberAuthor

timhoffmApr 5, 2020

Choose a reason for hiding this comment

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

I've moved this section to theMerging section to here because it covers mergin not automated tests.

timhoffm added this to thev3.3.0 milestone

Apr 11, 2020

timhoffm added the Documentation label

Apr 11, 2020

timhoffm force-pushed thedoc-test branch from05fc84f tocb856baCompare

April 11, 2020 11:10

Copy link

Member

QuLogic commentedApr 14, 2020

Unfortunately, I don't see any quick link to artifacts. Feel free to massage this into something useful:

Go to the Azure check, and click "View more details on Azure Pipelines". If you clicked on the overview, then the "Related" section should list a "# artifacts" link. If you clicked on a Job, then there should be a "# artifacts" link in the log.

Note, you won't see it on this PR because they're only posted on failure to save space.