Add a section to the docs on how to debug tasks. #1470
Conversation
I added a step I use frequently to inspect the state of the workspace before and after my Task steps execute. Feel free to add more!
googlebot
added
the
cla: yes
tekton-robot
added
the
size/M
| image: ubuntu | ||
| command: | ||
| - /bin/bash | ||
| args: |
There was a problem hiding this comment.
Do you want to do this with script:? Or will that maybe cause even more confusion if you're trying to debug script: ?
There was a problem hiding this comment.
That might be confusing indeed 👼
|
/test pull-tekton-pipeline-build-tests |
tekton-robot
added
the
approved
| image: ubuntu | ||
| command: | ||
| - /bin/bash | ||
| args: |
There was a problem hiding this comment.
That might be confusing indeed 👼
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dibyom, vdemeester The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| @@ -684,3 +685,46 @@ Except as otherwise noted, the content of this page is licensed under the | |||
| [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), | |||
| and code samples are licensed under the | |||
| [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). | |||
|
|
|||
| ## Debugging a Task | |||
There was a problem hiding this comment.
can you put a link to this in the TOC somewhere at the top of the file? might even be good to link from teh main README
|
|
||
| ## Debugging a Task | ||
|
|
||
| In software, we do things not because they are easy, but because we think they will be. |
| ### Inspecting the Filesystem | ||
|
|
||
| One common problem when writing Tasks is not understanding where files are on disk. | ||
| For the most part, these all live somewhere under `/workspace`, but the exact layout can |
There was a problem hiding this comment.
maybe we should link to some docs about /workspace here? (i think we have some) - also will need to update when jason's /tekton change goes in 😅
| - | | ||
| set -ex | ||
| find /workspace | ||
| ``` |
There was a problem hiding this comment.
oh yeah good call, i do this all the time too - to the point where maybe we should consider adding a "debug" mode that does something like this?
Changes
I added a step I use frequently to inspect the state of the workspace before
and after my Task steps execute. Feel free to add more!
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmddir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.
Release Notes