zuul/zuul-jobs
Code Issues Proposed changes

Update upload-afs README

Browse Source 
Explain the intention of this role and the details of .root-marker,
some of it is copied verbatim from the infra-specs repository design
document.

Change-Id: I6d9124c7eafadc4b53626ff2fef6be6399f61947
This commit is contained in:
Andreas Jaeger 2020-01-31 08:33:38 +01:00
parent fc27907b98
commit 1237417ea3
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
roles/upload-afs/README.rst
View File

@ -1,5 +1,20 @@
Copy contents from ``{{ zuul.executor.work_root }}/artifacts/`` to AFS
This is intented for documentation publishing, it deletes files that
do not exist in the content from the source.
Before the job rsyncs the build into its final location, it must first
create a list of directories that should not be deleted. This way if
an entire directory is removed from a document, it will still be
removed from the website, but directories which are themselves roots
of other documents (for example, the stein branch) are not removed. A
marker file, called `.root-marker`, at the root of each such directory
will accomplish this; therefore each build job should also ensure that
it leaves such a marker file at the root of its build. The job will
find each of those in the destination hierarchy and add their
containing directories to a list of directories to exclude from
rsyncing.
**Role Variables**
.. zuul:rolevar:: afs_source