zuul/zuul-jobs
Code Issues Proposed changes

Merge "upload-afs-synchronize: expand documentation"

Browse Source
This commit is contained in:
Zuul 2020-07-15 16:07:39 +00:00 committed by Gerrit Code Review
commit 8e4b52617c
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
roles/upload-afs-synchronize/README.rst
View File

@ -1,8 +1,17 @@
Copy contents from ``{{ zuul.executor.work_root }}/artifacts/`` to AFS
Copy contents of a directory hierarchy to AFS
This role uses the ``synchronzie`` module to copy directory contents
to a remote AFS locations. It ensures the ``synchronize`` flags,
particularly relating to group and world permissions, are appropriate
for copying to AFS locations.
See also :zuul:role:`upload-afs-roots` which is a similar role giving
more fine-grained control over which directories are synchronized.
**Role Variables**
.. zuul:rolevar:: afs_source
:default: ``{{ zuul.executor.work_root }}/artifacts/``
Path to local source directory.