Skip to content
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

Output doctest logs on nightly #35964

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Aug 24, 2023

Description of work
This PR should make it easier to debug issues with our nightly pipeline when it fails building the docs-doctest target. The output from this will now be put into a file in the build directory called doctest_$OS_TYPE.log, and then uploaded as an artifact at the end of the pipeline. This will mean it will appear in the "build artifacts" screen for the job. Previously, Xvfb would swallow any output from the building of docs-doctest and not show us anything. This has been avoided by using the QT_QPA_PLATFORM=offscreen variable instead of Xvfb.

To test:
Code review, and check that you can see a doctest_$OS_TYPE.log files in the build artefacts for this run. There will be no doctest_msys.log for windows because the doc tests do not get run on windows.
https://builds.mantidproject.org/job/build_packages_from_branch/509/

There is no associated issue.

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review
  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Are the release notes saved in a separate file, using Issue or PR number for file name and in the correct location?
Functional Tests
  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@robertapplin robertapplin added the DevOps Issues and pull requests related to DevOps label Aug 24, 2023
@robertapplin robertapplin changed the title Better output for doctests on nightly Output doctest logs on nightly Aug 24, 2023
Copy link
Contributor

@thomashampson thomashampson left a comment

Choose a reason for hiding this comment

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

This is a nice concise change to reduce the size of the build logs to something more manageable. However there is one problem I can see with the renaming of the ctest log files.

Copy link
Contributor

@thomashampson thomashampson left a comment

Choose a reason for hiding this comment

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

This looks to be working well. We just need to remember to archive the doctest logs on the PR builds on Jenkins

@SilkeSchomann SilkeSchomann merged commit d0d672f into mantidproject:main Aug 25, 2023
@robertapplin robertapplin deleted the 0-better-output-for-doctests-on-nightly branch October 22, 2023 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DevOps Issues and pull requests related to DevOps
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants