Andreas Jaeger 1237417ea3 Update upload-afs README
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
2020-01-31 08:33:38 +01:00
..
2017-08-29 15:43:22 -04:00
2018-07-25 09:11:25 -07:00
2017-08-29 15:43:22 -04:00
2018-08-17 10:23:20 +10:00
2020-01-31 08:33:38 +01:00

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

Path to local source directory.

Target path in AFS (should begin with '/afs/...').