zuul
/
zuul-jobs
Code Issues Proposed changes

Clarify that stage-output doesn't actually write to zuul_output_dir 

The stage-output role's README indicates that it stages to the
zuul_output_dir on the remote node, but this isn't true. It actually
stages to {{ stage_dir }} which has a different default than
{{ zuul_output_dir }} in fetch-output.

Update the readme to make this more clear and reduce confusion.

Change-Id: I7a7ef801db8194a7101a8dc0a6d89e1292b3fa86
This commit is contained in:
Clark Boylan 2022-09-26 11:22:11 -07:00 committed by Clark Boylan
parent 1b69121aa2
commit 6ff47d56db
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
roles/stage-output/README.rst
View File

@ -1,8 +1,10 @@
Stage job output on the remote node
Takes as input a dictionary of files/folders named 'zuul_copy_output'.
Copies contents into {{ zuul_output_dir }} on the remote node and is
Copies contents into {{ stage_dir }} on the remote node and is
intended to be used before output fetching in a base job's post-playbook.
If you plan to pair this role with the 'fetch-output' role you should
ensure {{ stage-dir }] is set to match {{ zuul_output_dir }}.
**Role Variables**