This will fix #4894 by adding another tutorial to the debugging page. The tutorial shows using toil debug-job to sneak inside a Docker container locally and inspect the behavior of a stuck WDL task.
It also includes fixes I needed for problems I encountered when trying to write a workflow that failed the way I wanted instead of in other ways. I was stuck for quite a while because my Docker Desktop installation had decided to change its file sharing mode without telling me.
[ ] New functions or classes without informative docstrings.
[ ] Changes to semantics not reflected in the relevant docstrings.
[ ] New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
[ ] New features without tests.
[ ] Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
[ ] Finish the review with an overall description of your opinion.
Merger Checklist
[ ] Make sure the PR passes tests.
[ ] Make sure the PR has been reviewed since its last modification. If not, review it.
[ ] Merge with the Github "Squash and merge" feature.
[ ] If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
[ ] Copy its recommended changelog entry to the Draft Changelog.
[ ] Append the issue number in parentheses to the changelog entry.
This will fix #4894 by adding another tutorial to the debugging page. The tutorial shows using
toil debug-job
to sneak inside a Docker container locally and inspect the behavior of a stuck WDL task.It also includes fixes I needed for problems I encountered when trying to write a workflow that failed the way I wanted instead of in other ways. I was stuck for quite a while because my Docker Desktop installation had decided to change its file sharing mode without telling me.
Changelog Entry
To be copied to the draft changelog by merger:
toil debug-job
toil debug-job
now leaves behind the worker's temp files after running, so you can look at them.Reviewer Checklist
issues/XXXX-fix-the-thing
in the Toil repo, or from an external repo.camelCase
that want to be insnake_case
.docs/running/{cliOptions,cwl,wdl}.rst
Merger Checklist