From 6ff47d56db543439113521b89567b91833e4d880 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Mon, 26 Sep 2022 11:22:11 -0700 Subject: [PATCH] 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 --- roles/stage-output/README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/roles/stage-output/README.rst b/roles/stage-output/README.rst index 8b6fb59ec..a2616d421 100644 --- a/roles/stage-output/README.rst +++ b/roles/stage-output/README.rst @@ -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**