Skip to content

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.

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

Jump to bottom
Merged
QuLogic merged 1 commit into from
Apr 17, 2020
Merged

Improve docs on automated tests #17040

QuLogic merged 1 commit into from
Apr 17, 2020

Conversation

@timhoffm
Copy link
Member

@timhoffm timhoffm commented Apr 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.

@QuLogic
Copy link
Member

QuLogic commented Apr 6, 2020

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

@timhoffm
Copy link
Member Author

timhoffm commented Apr 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
timhoffm commented Apr 11, 2020
View reviewed changes
doc/devel/coding_guide.rst
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
Member Author

@timhoffm timhoffm Apr 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 the Merging section to here because it covers mergin not automated tests.

@timhoffm timhoffm added this to the v3.3.0 milestone Apr 11, 2020
@QuLogic
Copy link
Member

QuLogic commented Apr 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.

@timhoffm
Copy link
Member Author

timhoffm commented Apr 16, 2020

Added a section on image artifacts on Azure.

@QuLogic QuLogic merged commit 30d1396 into matplotlib:master Apr 17, 2020
@QuLogic QuLogic mentioned this pull request Apr 17, 2020
Merged
1 task
@timhoffm timhoffm deleted the doc-test branch April 17, 2020 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@QuLogic QuLogic QuLogic approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v3.3.0

Development

Successfully merging this pull request may close these issues.

2 participants

@timhoffm @QuLogic