From 840c2c0b83502299f80ea6263bfc0b98946c20ae Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 17 Oct 2017 21:13:52 +0200 Subject: [PATCH] prepare-docs-for-afs: Allow reuse Allow reuse of the roles for other directories than doc/build/html with making doc_build_dir a variable that can be overwritten. This allows to use the role also for e.g. deploy-guide that lives under deploy-guide/source and builds under deploy-guide/build. Change-Id: I61cd84be201d14d0a1d5daba3a45c8797496bc7f Needed-By: Ifff767a95e6283c54033bababd3dae84bb19adb6 --- roles/prepare-docs-for-afs/README.rst | 12 +++++++++++- roles/prepare-docs-for-afs/defaults/main.yaml | 1 + roles/prepare-docs-for-afs/tasks/main.yaml | 4 ---- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/roles/prepare-docs-for-afs/README.rst b/roles/prepare-docs-for-afs/README.rst index 0c593fe0..60e1eb91 100644 --- a/roles/prepare-docs-for-afs/README.rst +++ b/roles/prepare-docs-for-afs/README.rst @@ -1 +1,11 @@ -Prepare built openstack docs to be published to the OpenStack AFS cell. +Prepare built OpenStack docs to be published to the OpenStack AFS cell. + +.. zuul:rolevar:: zuul_work_dir + :default: {{ zuul.project.src_dir }} + + Directory to build documentation in. + +.. zuul:rolevar:: doc_build_dir + :default: {{ zuul_work_dir }}/doc/build + + Directory that contains the built documentation. diff --git a/roles/prepare-docs-for-afs/defaults/main.yaml b/roles/prepare-docs-for-afs/defaults/main.yaml index 189d518f..775dccc4 100644 --- a/roles/prepare-docs-for-afs/defaults/main.yaml +++ b/roles/prepare-docs-for-afs/defaults/main.yaml @@ -1 +1,2 @@ zuul_work_dir: "src/{{ zuul.project.canonical_name }}" +doc_build_dir: "{{ zuul_work_dir }}/doc/build" diff --git a/roles/prepare-docs-for-afs/tasks/main.yaml b/roles/prepare-docs-for-afs/tasks/main.yaml index 3dc217f6..44066f52 100644 --- a/roles/prepare-docs-for-afs/tasks/main.yaml +++ b/roles/prepare-docs-for-afs/tasks/main.yaml @@ -1,7 +1,3 @@ -- name: Set build dir fact - set_fact: - doc_build_dir: "{{ zuul_work_dir }}/doc/build" - - name: Write marker text copy: dest: "{{ doc_build_dir }}/html/.root-marker"